components:
  schemas:
    AOTChartBins:
      properties:
        actual:
          description: The average actual value of the target in the bin. ``null``
            if there are no entries in the bin or if this is an anomaly detection
            project.
          nullable: true
          type: number
        endDate:
          description: The datetime of the end of the bin (exclusive).
          format: date-time
          type: string
        frequency:
          description: As indicated by the frequencyType in the Metadata, used to
            determine what the averages mentioned above are taken over. ``null`` if
            there are no entries in the bin.
          nullable: true
          type: number
        predicted:
          description: The average prediction of the model in the bin. ``null`` if
            there are no entries in the bin.
          nullable: true
          type: number
        startDate:
          description: The datetime of the start of the bin (inclusive).
          format: date-time
          type: string
      required:
      - actual
      - endDate
      - frequency
      - predicted
      - startDate
      type: object
    AOTChartMetadataDatasetMetadata:
      properties:
        endDate:
          description: ISO-8601 formatted end date (max date) in the dataset.
          format: date-time
          type: string
        startDate:
          description: ISO-8601 formatted start date (min date) in the dataset.
          format: date-time
          type: string
      required:
      - endDate
      - startDate
      type: object
    AOTChartMetadataResponse:
      properties:
        datasetId:
          description: The dataset id which was used to compute the AOT chart.
          type: string
        datasetMetadata:
          $ref: '#/components/schemas/AOTChartMetadataDatasetMetadata'
          description: The dataset metadata.
        frequencyType:
          description: How to interpret the frequency attribute of each datetimeTrendBin.
            One of ['rowCount', 'weightedRowCount', 'exposure', 'weightedExposure'].
          enum:
          - rowCount
          - weightedRowCount
          - exposure
          - weightedExposure
          type: string
        metricName:
          description: The metric used to score each bin and the calculate the metric
            attribute of each datetimeTrendBin.
          type: string
        modelId:
          description: The model id which was used to compute the AOT chart.
          type: string
        projectId:
          description: The project id which was used to compute the AOT chart.
          type: string
        resolutions:
          description: Suggested time resolutions where a resolution is one of ['milliseconds',
            'seconds', 'minutes', 'hours', 'days', 'weeks', 'months', 'years'].
          items:
            enum:
            - microseconds
            - milliseconds
            - seconds
            - minutes
            - hours
            - days
            - weeks
            - months
            - quarters
            - years
            type: string
          type: array
      required:
      - datasetId
      - datasetMetadata
      - frequencyType
      - metricName
      - modelId
      - projectId
      - resolutions
      type: object
    AOTChartPreviewResponse:
      properties:
        bins:
          description: The datetime chart data for that source.
          items:
            $ref: '#/components/schemas/AOTChartBins'
          type: array
        datasetId:
          description: The dataset id which was used to compute the AOT chart.
          type: string
        modelId:
          description: The model id which was used to compute the AOT chart.
          type: string
        projectId:
          description: The project id which was used to compute the AOT chart.
          type: string
      required:
      - bins
      - datasetId
      - modelId
      - projectId
      type: object
    AOTChartRetrieveResponse:
      properties:
        bins:
          description: The datetime chart data for that source.
          items:
            $ref: '#/components/schemas/AOTChartBins'
          type: array
        datasetId:
          description: The dataset id to which the chart data belongs.
          type: string
        endDate:
          description: 'The requested `endDate`, or, if not specified, the end date
            for this dataset (exclusive). Example: ''2010-05-13T00:00:00.000000Z''.'
          format: date-time
          type: string
        modelId:
          description: The model id to which the chart data belongs.
          type: string
        projectId:
          description: The project id to which the chart data belongs.
          type: string
        resolution:
          description: The resolution used for binning where a resolution is one of
            ['milliseconds', 'seconds', 'minutes', 'hours', 'days', 'weeks', 'months',
            'years'].
          enum:
          - microseconds
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
        startDate:
          description: 'The requested `startDate`, or, if not specified, the start
            date for this dataset. Example: ''2010-05-13T00:00:00.000000Z''.'
          format: date-time
          type: string
        statistics:
          $ref: '#/components/schemas/AOTChartStatistics'
          description: Statistics calculated on the chart data.
      required:
      - bins
      - datasetId
      - modelId
      - projectId
      - resolution
      - statistics
      type: object
    AOTChartStatistics:
      properties:
        durbinWatson:
          description: The Durbin-Watson statistic for the chart data. Value is between
            0 and 4. Returns -1 when the statistic is invalid for the data, e.g. if
            this is an anomaly detection project.
          type: number
      required:
      - durbinWatson
      type: object
    AccessControl:
      properties:
        canShare:
          description: Whether the recipient can share the role further.
          type: boolean
        role:
          description: The role of the user on this entity.
          type: string
        userId:
          description: The identifier of the user that has access to this entity.
          type: string
        username:
          description: The username of the user that has access to the entity.
          type: string
      required:
      - canShare
      - role
      - userId
      - username
      type: object
    AccessControlV2:
      properties:
        id:
          description: The identifier of the recipient.
          type: string
        name:
          description: The name of the recipient.
          type: string
        role:
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          description: The type of the recipient.
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
    AccessControlWithGrant:
      properties:
        canShare:
          description: Whether the recipient can share the role further.
          type: boolean
        id:
          description: The identifier of the recipient.
          type: string
        name:
          description: The name of the recipient.
          type: string
        role:
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          description: The type of the recipient.
          enum:
          - user
          - group
          - organization
          type: string
        userFullName:
          description: Full name of the recipient user.
          type: string
      required:
      - canShare
      - id
      - name
      - role
      - shareRecipientType
      type: object
    AccuracyBatchBaselineBucket:
      properties:
        metric:
          description: Name of the metric.
          type: string
          x-versionadded: v2.33
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
          x-versionadded: v2.33
        perClass:
          description: Accuracy metric for selected classes.
          items:
            $ref: '#/components/schemas/AccuracyPerClass'
          type: array
          x-versionadded: v2.33
        sampleSize:
          description: Number of rows used to calculate the metric.
          type: integer
          x-versionadded: v2.33
        value:
          description: Accuracy metric value.
          nullable: true
          type: number
          x-versionadded: v2.33
      required:
      - metric
      - sampleSize
      - value
      type: object
    AccuracyBatchBucket:
      properties:
        batchId:
          description: ID of the batch.
          type: string
          x-versionadded: v2.33
        batchName:
          description: Name of the batch.
          type: string
          x-versionadded: v2.33
        metric:
          description: Name of the metric.
          type: string
          x-versionadded: v2.33
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
          x-versionadded: v2.33
        perClass:
          description: Accuracy metric for selected classes.
          items:
            $ref: '#/components/schemas/AccuracyPerClass'
          type: array
          x-versionadded: v2.33
        period:
          $ref: '#/components/schemas/BatchPeriod'
          description: Time period of the batch.
          x-versionadded: v2.33
        sampleSize:
          description: Number of rows used to calculate the metric.
          type: integer
          x-versionadded: v2.33
        value:
          description: Accuracy metric value.
          nullable: true
          type: number
          x-versionadded: v2.33
      required:
      - batchId
      - batchName
      - metric
      - period
      - sampleSize
      - value
      type: object
    AccuracyHealth:
      properties:
        batchCount:
          description: Number of recent batches used to compute accuracy health status,
            only applicable to deployments with batch monitoring enabled.
          enum:
          - '1'
          - '5'
          - '10'
          - '50'
          - '100'
          - '1000'
          - '10000'
          type: string
          x-versionadded: v2.33
        failingThreshold:
          description: Threshold for failing status.
          nullable: true
          type: number
          x-versionadded: v2.33
        measurement:
          description: Measurement for calculating accuracy health status.
          enum:
          - percent
          - value
          nullable: true
          type: string
          x-versionadded: v2.33
        metric:
          description: Metric used for calculating accuracy health status.
          enum:
          - AUC
          - Accuracy
          - Balanced Accuracy
          - F1
          - FPR
          - FVE Binomial
          - FVE Gamma
          - FVE Multinomial
          - FVE Poisson
          - FVE Tweedie
          - Gamma Deviance
          - Gini Norm
          - Kolmogorov-Smirnov
          - LogLoss
          - MAE
          - MAPE
          - MCC
          - NPV
          - PPV
          - Poisson Deviance
          - R Squared
          - RMSE
          - RMSLE
          - Rate@Top10%
          - Rate@Top5%
          - TNR
          - TPR
          - Tweedie Deviance
          nullable: true
          type: string
          x-versionadded: v2.33
        warningThreshold:
          description: Threshold for warning status.
          nullable: true
          type: number
          x-versionadded: v2.33
      type: object
    AccuracyLegacyTimeBucket:
      properties:
        period:
          $ref: '#/components/schemas/TimeRange'
          description: Start and end of the bucket's queried period, null if bucket
            is calculated on training data.
          nullable: true
        sampleSize:
          description: Number of predictions used to calculate the metric.
          nullable: true
          type: integer
        value:
          description: Value of the metric, null if no value.
          nullable: true
          type: number
        valuePerClass:
          description: A dict keyed by class names with metric calculated for specific
            classes as values, if targetClass is set. Deprecated and to be removed
            in v2.35, use perClass instead.
          example: "\n                {\n                    \"class1\": 0.880778024500618,\n\
            \                    \"class2\": 0.5294117647058824,\n               \
            \     \"class3\": 0.4117647058823529\n                }\n            "
          nullable: true
          type: object
      required:
      - period
      - sampleSize
      - value
      type: object
    AccuracyMetrics:
      properties:
        metric:
          description: The name of the metric.
          enum:
          - AUC
          - Weighted AUC
          - Area Under PR Curve
          - Weighted Area Under PR Curve
          - Kolmogorov-Smirnov
          - Weighted Kolmogorov-Smirnov
          - FVE Binomial
          - Weighted FVE Binomial
          - Gini Norm
          - Weighted Gini Norm
          - LogLoss
          - Weighted LogLoss
          - Max MCC
          - Weighted Max MCC
          - Rate@Top5%
          - Weighted Rate@Top5%
          - Rate@Top10%
          - Weighted Rate@Top10%
          - Rate@TopTenth%
          - RMSE
          - Weighted RMSE
          - f1
          - accuracy
          type: string
        value:
          description: The calculated score of the metric.
          maximum: 1.0
          minimum: 0.0
          type: number
      required:
      - metric
      - value
      type: object
    AccuracyOverBatchResponse:
      properties:
        baselines:
          description: Accuracy metric training baseline.
          items:
            $ref: '#/components/schemas/AccuracyBatchBaselineBucket'
          type: array
          x-versionadded: v2.33
        buckets:
          description: Accuracy metric for batches that are requested, with non-existing
            batches omitted.
          items:
            $ref: '#/components/schemas/AccuracyBatchBucket'
          type: array
          x-versionadded: v2.33
      required:
      - baselines
      - buckets
      type: object
    AccuracyOverTimePlotsBins:
      properties:
        actual:
          description: Average actual value of the target in the bin. `null` if there
            are no entries in the bin.
          nullable: true
          type: number
        endDate:
          description: 'The datetime of the end of the bin (exclusive). '
          format: date-time
          type: string
        frequency:
          description: Indicates number of values averaged in bin in case of a resolution
            change.
          nullable: true
          type: integer
        predicted:
          description: Average prediction of the model in the bin. `null` if there
            are no entries in the bin.
          nullable: true
          type: number
        startDate:
          description: 'The datetime of the start of the bin (inclusive). '
          format: date-time
          type: string
      required:
      - actual
      - endDate
      - frequency
      - predicted
      - startDate
      type: object
    AccuracyOverTimePlotsDataResponse:
      properties:
        bins:
          description: An array of bins for the retrieved plots.
          items:
            $ref: '#/components/schemas/AccuracyOverTimePlotsBins'
          maxItems: 1000
          minItems: 1
          type: array
        calendarEvents:
          description: An array of calendar events for a retrieved plot.
          items:
            $ref: '#/components/schemas/CalendarEvent'
          maxItems: 1000
          type: array
        endDate:
          description: 'The datetime of the end of the chart data (exclusive). '
          format: date-time
          type: string
        resolution:
          description: The resolution that is used for binning.
          enum:
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
        startDate:
          description: 'The datetime of the start of the chart data (inclusive). '
          format: date-time
          type: string
        statistics:
          $ref: '#/components/schemas/AccuracyOverTimePlotsStatistics'
          description: Statistics calculated for the chart data.
      required:
      - bins
      - calendarEvents
      - endDate
      - resolution
      - startDate
      - statistics
      type: object
    AccuracyOverTimePlotsMetadataResponse:
      properties:
        backtestMetadata:
          description: An array of metadata information for each backtest. The array
            index of metadata object is the backtest index.
          items:
            $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
          maxItems: 20
          minItems: 1
          type: array
        backtestStatuses:
          description: An array of status information for each backtest. The array
            index of status object is the backtest index.
          items:
            $ref: '#/components/schemas/AccuracyOverTimePlotsStatus'
          maxItems: 20
          minItems: 1
          type: array
        estimatedSeriesLimit:
          description: Estimated number of series that can be calculated in one request
            for 1 FD.
          minimum: 1
          type: integer
        forecastDistance:
          description: The forecast distance for which the data was retrieved. `null`
            for OTV projects.
          maximum: 1000
          minimum: 0
          nullable: true
          type: integer
        holdoutMetadata:
          $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
          description: Metadata information for holdout.
        holdoutStatuses:
          $ref: '#/components/schemas/AccuracyOverTimePlotsStatus'
          description: Status information for holdout.
        resolutions:
          description: An array of available time resolutions for which plots can
            be retrieved.
          items:
            enum:
            - milliseconds
            - seconds
            - minutes
            - hours
            - days
            - weeks
            - months
            - quarters
            - years
            type: string
          maxItems: 9
          minItems: 1
          type: array
      required:
      - backtestMetadata
      - backtestStatuses
      - forecastDistance
      - holdoutMetadata
      - holdoutStatuses
      - resolutions
      type: object
    AccuracyOverTimePlotsStatistics:
      properties:
        durbinWatson:
          description: The Durbin-Watson statistic for the chart data. Value is between
            0 and 4. Durbin-Watson statistic is a test statistic used to detect the
            presence of autocorrelation at lag 1 in the residuals (prediction errors)
            from a regression analysis. More info https://wikipedia.org/wiki/Durbin%E2%80%93Watson_statistic
          maximum: 4
          minimum: 0
          nullable: true
          type: number
      required:
      - durbinWatson
      type: object
    AccuracyOverTimePlotsStatus:
      properties:
        training:
          description: The status for the training.
          enum:
          - completed
          - errored
          - inProgress
          - insufficientData
          - notCompleted
          - notSupported
          type: string
        validation:
          description: The status for the validation.
          enum:
          - completed
          - errored
          - inProgress
          - insufficientData
          - notCompleted
          - notSupported
          type: string
      required:
      - training
      - validation
      type: object
    AccuracyOverTimeResponse:
      properties:
        baseline:
          $ref: '#/components/schemas/AccuracyLegacyTimeBucket'
          description: A bucket object containing metric info calculated on training
            baseline. Deprecated and to be removed in v2.35, use baselines field instead.
          x-versiondeprecated: v2.33
        baselines:
          description: Accuracy metric training baseline.
          items:
            $ref: '#/components/schemas/AccuracyTimeBaselineBucket'
          type: array
        buckets:
          description: Accuracy metric for requested models and time buckets.
          items:
            $ref: '#/components/schemas/AccuracyTimeBucket'
          type: array
        metric:
          description: The metric being retrieved.
          enum:
          - AUC
          - Accuracy
          - Balanced Accuracy
          - F1
          - FPR
          - FVE Binomial
          - FVE Gamma
          - FVE Multinomial
          - FVE Poisson
          - FVE Tweedie
          - Gamma Deviance
          - Gini Norm
          - Kolmogorov-Smirnov
          - LogLoss
          - MAE
          - MAPE
          - MCC
          - NPV
          - PPV
          - Poisson Deviance
          - R Squared
          - RMSE
          - RMSLE
          - Rate@Top10%
          - Rate@Top5%
          - TNR
          - TPR
          - Tweedie Deviance
          type: string
        modelId:
          description: The id of the model for which metrics are being retrieved.
            Deprecated and to be removed in v2.35, use modelId in each baseline or
            bucket object.
          type: string
          x-versiondeprecated: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/AccuracyLegacyTimeBucket'
          description: A bucket object containing metric info calculated. Deprecated
            and to be removed in v2.35, use summaries field with includeSummaries
            query param to get accuracy metrics computed over the whole time range.
          x-versiondeprecated: v2.33
      required:
      - baseline
      - baselines
      - buckets
      - metric
      - summary
      type: object
    AccuracyPerClass:
      properties:
        className:
          description: Name of the class.
          type: string
        value:
          description: Value of the metric.
          nullable: true
          type: number
      required:
      - className
      - value
      type: object
    AccuracyResponse:
      properties:
        batchIds:
          description: ID of the batches used to calculate accuracy metrics.
          items:
            type: string
          type: array
        metrics:
          description: "Accuracy metrics of the deployment, keyed by metric names,\n\
            \                                 each value is a `metric` object with\
            \ detail on a single metric.\n                                 For classification\
            \ deployments:\n                                 - LogLoss\n         \
            \                        - AUC\n                                 - Kolmogorov\
            \ - Smirnov\n                                 - Gini Norm\n          \
            \                       - Rate @ Top10 %\n                           \
            \      For regression deployments:\n                                 -\
            \ RMSE\n                                 - MAE\n                     \
            \            - Gamma Deviance\n                                 - Tweedie\
            \ Deviance\n                                 - R Squared"
          example: "\n                {\"metrics\": {\n                    \"LogLoss\"\
            : {\n                        \"baselineValue\": 0.454221484838069,\n \
            \                       \"value\": 0.880778024500618,\n              \
            \          \"percentChange\": -93.91\n                    },\n       \
            \             \"AUC\": {\n                        \"baselineValue\": 0.8690358459556535,\n\
            \                        \"value\": 0.5294117647058824,\n            \
            \            \"percentChange\": -39.08\n                    },\n     \
            \               \"Kolmogorov-Smirnov\": {\n                        \"\
            baselineValue\": 0.5753202944706626,\n                        \"value\"\
            : 0.4117647058823529,\n                        \"percentChange\": -28.43\n\
            \                    },\n                    \"Rate@Top10%\": {\n    \
            \                    \"baselineValue\": 0.9603223806571606,\n        \
            \                \"value\": 1.0,\n                        \"percentChange\"\
            : 4.13\n                    },\n                    \"Gini Norm\": {\n\
            \                        \"baselineValue\": 0.7380716919113071,\n    \
            \                    \"value\": 0.05882352941176472,\n               \
            \         \"percentChange\": -92.03\n                    }\n         \
            \       }\n                "
          type: object
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: Time Range used to calculate accuracy metrics.
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
        targetClasses:
          description: Target classes provided in the request.
          nullable: true
          type: string
      required:
      - metrics
      type: object
    AccuracyTimeBaselineBucket:
      properties:
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        perClass:
          description: Accuracy metric values for selected classes, only available
            for multiclass deployments.
          items:
            $ref: '#/components/schemas/AccuracyPerClass'
          type: array
        sampleSize:
          description: Number of rows used to calculate the metric.
          type: integer
        value:
          description: Accuracy metric value.
          nullable: true
          type: number
      required:
      - sampleSize
      - value
      type: object
    AccuracyTimeBucket:
      properties:
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        perClass:
          description: Accuracy metric values for selected classes, only available
            for multiclass deployments.
          items:
            $ref: '#/components/schemas/AccuracyPerClass'
          type: array
        period:
          $ref: '#/components/schemas/TimeRange'
          description: Time period of the bucket.
        sampleSize:
          description: Number of rows used to calculate the metric.
          type: integer
        value:
          description: Accuracy metric value.
          nullable: true
          type: number
        valuePerClass:
          description: A dict keyed by class names with metric calculated for specific
            classes as values, if targetClass is set. Deprecated and to be removed
            in v2.35, use perClass instead.
          example: "\n                {\n                    \"class1\": 0.880778024500618,\n\
            \                    \"class2\": 0.5294117647058824,\n               \
            \     \"class3\": 0.4117647058823529\n                }\n            "
          nullable: true
          type: object
          x-versiondeprecated: v2.33
      required:
      - period
      - sampleSize
      - value
      type: object
    ActivationMap:
      properties:
        activationValues:
          description: A 2D matrix of values (row-major) representing the activation
            strengths for particular image regions.
          items:
            items:
              maximum: 255
              minimum: 0
              type: integer
            type: array
          type: array
        actualTargetValue:
          description: Actual target value of the dataset row
          nullable: true
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
        featureName:
          description: The name of the column containing the image value the activation
            map is based upon.
          type: string
        imageHeight:
          description: The height of the original image (in pixels) this activation
            map has been computed for.
          type: integer
        imageId:
          description: ID of the original image this activation map has been computed
            for.
          type: string
        imageWidth:
          description: The width of the original image (in pixels) this activation
            map has been computed for.
          type: integer
        links:
          $ref: '#/components/schemas/ActivationMapLinks'
          description: Download URLs
        overlayImageId:
          description: ID of the image containing the original image overlaid by the
            activation heatmap.
          type: string
        predictedTargetValue:
          description: predicted target value of the dataset row containing this image.
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
      required:
      - activationValues
      - actualTargetValue
      - featureName
      - imageHeight
      - imageId
      - imageWidth
      - links
      - overlayImageId
      - predictedTargetValue
      type: object
    ActivationMapLinks:
      properties:
        downloadOriginalImage:
          description: URL of the original image
          format: uri
          type: string
        downloadOverlayImage:
          description: URL of the original image overlaid by the activation heatmap
          format: uri
          type: string
      required:
      - downloadOriginalImage
      - downloadOverlayImage
      type: object
    ActivationMapsComputeResponse:
      properties:
        id:
          description: The job ID.
          type: string
        isBlocked:
          description: True if the job is waiting for its dependencies to be resolved
            first.
          type: boolean
        jobType:
          description: the type of the job
          enum:
          - compute_image_activation_maps
          type: string
        message:
          description: Error message in case of failure.
          type: string
        modelId:
          description: the model ID of the target model
          type: string
        projectId:
          description: The project the job belongs to.
          type: string
        status:
          description: The job status.
          enum:
          - queue
          - inprogress
          - error
          - ABORTED
          - COMPLETED
          type: string
        url:
          description: A URL that can be used to request details about the job.
          type: string
      required:
      - id
      - isBlocked
      - jobType
      - message
      - modelId
      - projectId
      - status
      - url
      type: object
    ActivationMapsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of Image Activation Maps
          items:
            $ref: '#/components/schemas/ImageInsightsMetadataElement'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ActivationMapsRetrieveResponse:
      properties:
        activationMapHeight:
          description: The height of each activation map (the number of rows in each
            activationValues matrix).
          nullable: true
          type: integer
        activationMapWidth:
          description: The width of each activation map (the number of items in each
            row of each activationValues matrix).
          nullable: true
          type: integer
        activationMaps:
          description: List of activation map objects
          items:
            $ref: '#/components/schemas/ActivationMap'
          type: array
        targetBins:
          description: List of bin objects for regression or null
          items:
            $ref: '#/components/schemas/TargetBin'
          nullable: true
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          nullable: true
          type: array
      required:
      - activationMapHeight
      - activationMapWidth
      - activationMaps
      - targetBins
      - targetValues
      type: object
    Actual:
      properties:
        actualValue:
          anyOf:
          - type: integer
          - type: number
          - type: string
          description: The actual value of a prediction. Will be numeric for regression
            models and a string label for classification models.
        associationId:
          description: A unique identifier used with a predicted row.
          maxLength: 128
          type: string
        timestamp:
          description: The datetime when actual values were obtained, formatted according
            to RFC3339.
          format: date-time
          nullable: true
          type: string
          x-versiondeprecated: v2.32
        wasActedOn:
          description: Indicates if the prediction was acted on in a way that could
            have affected the actual outcome. For example, if a hospital patient is
            predicted to be readmitted in 30 days, extra procedures or new medication
            might be given to mitigate this problem, influencing the actual outcome
            of the prediction.
          nullable: true
          type: boolean
          x-versiondeprecated: v2.32
      required:
      - actualValue
      - associationId
      type: object
    ActualClassDistribution:
      properties:
        className:
          description: Name of the class.
          type: string
        count:
          description: Count of actual rows labeled with a class in the bucket.
          type: integer
        percent:
          description: Percent of actual rows labeled with a class in the bucket.
          type: number
      required:
      - className
      - count
      - percent
      type: object
    ActualFrequency:
      properties:
        otherClassName:
          description: The name of the class.
          type: string
        percentage:
          description: The percentage of the times this class was predicted when is
            was actually `classMetrics.className` (from 0 to 100).
          maximum: 100
          minimum: 0
          type: number
        value:
          description: The count of the times this class was predicted when is was
            actually `classMetrics.className`.
          minimum: 0
          type: integer
      required:
      - otherClassName
      - percentage
      - value
      type: object
    ActualPercentages:
      properties:
        otherClassName:
          description: the name of the class
          type: string
        percentage:
          description: The percentage of the times this class was predicted when is
            was actually `classMetrics.className`
          type: number
      required:
      - otherClassName
      - percentage
      type: object
    ActualValueColumnInfo:
      properties:
        missingCount:
          description: Count of the missing values in the column.
          type: integer
          x-versionadded: v2.21
        name:
          description: Name of the column.
          type: string
          x-versionadded: v2.21
      required:
      - missingCount
      - name
      type: object
    ActualsCreatedBy:
      properties:
        id:
          description: The ID of user who created actuals data export.
          type: string
          x-versionadded: v2.33
      required:
      - id
      type: object
    ActualsDataEntry:
      properties:
        id:
          description: The ID of an entry.
          type: string
          x-versionadded: v2.33
        name:
          description: A name of an entry.
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      type: object
    ActualsDataExportEntity:
      properties:
        createdAt:
          description: Actuals data export creation timestamp.
          format: date-time
          type: string
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/ActualsCreatedBy'
          description: The user that created actuals data export.
          x-versionadded: v2.33
        data:
          description: An actuals data export collected data entries. Available only
            when status is SUCCEEDED.
          items:
            $ref: '#/components/schemas/ActualsDataEntry'
          nullable: true
          type: array
          x-versionadded: v2.33
        error:
          $ref: '#/components/schemas/ActualsError'
          description: Error description. Appears when actuals data export job failed
            (status is FAILED).
          nullable: true
          x-versionadded: v2.33
        id:
          description: The ID of the actuals data export.
          type: string
          x-versionadded: v2.33
        modelId:
          description: The ID of the model (or null if not specified).
          type: string
          x-versionadded: v2.33
        onlyMatchedPredictions:
          default: true
          description: If true, exports actuals with matching predictions only.
          type: boolean
          x-versionadded: v2.33
        period:
          $ref: '#/components/schemas/ActualsDataTimeRange'
          description: An actuals data time range definition.
          x-versionadded: v2.33
        status:
          description: An actuals data export processing state.
          enum:
          - CANCELLED
          - CREATED
          - FAILED
          - SCHEDULED
          - SUCCEEDED
          type: string
          x-versionadded: v2.33
      required:
      - createdAt
      - createdBy
      - id
      - modelId
      - period
      - status
      type: object
    ActualsDataTimeRange:
      properties:
        end:
          description: End of the period of actuals data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
        start:
          description: Start of the period of actuals data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
      required:
      - end
      - start
      type: object
    ActualsDataUpdate:
      properties:
        status:
          description: An actuals data export state overwrite value.
          enum:
          - CANCELLED
          type: string
          x-versionadded: v2.33
      type: object
    ActualsError:
      properties:
        message:
          description: A human readable error message describing failure cause.
          type: string
          x-versionadded: v2.33
      required:
      - message
      type: object
    ActualsExportCreatePayload:
      properties:
        end:
          description: End of the period of actuals data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
        modelId:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        onlyMatchedPredictions:
          default: true
          description: If true, exports actuals with matching predictions only.
          type: boolean
          x-versionadded: v2.33
        start:
          description: Start of the period of actuals data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
      required:
      - end
      - start
      type: object
    ActualsExportListResponse:
      properties:
        count:
          description: Number of paginated entries.
          minimum: 0
          type: integer
          x-versionadded: v2.33
        data:
          description: A list of asynchronous actuals data exports.
          items:
            $ref: '#/components/schemas/ActualsDataExportEntity'
          type: array
          x-versionadded: v2.33
        next:
          description: URL to the next page, or null if there is no such page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL to the previous page, or null if there is no such page
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: Total number of entries.
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    AddDeploymentToApplication:
      properties:
        linkName:
          description: Internal name of deployment to match in the application
          type: string
        modelDeploymentId:
          description: The ID of the model deployment to link to the application.
          type: string
      required:
      - modelDeploymentId
      type: object
    AddUsersToGroupResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of users in the group.
          items:
            $ref: '#/components/schemas/UserInGroup'
          type: array
      required:
      - count
      - data
      type: object
    AdminSampleSize:
      properties:
        type:
          description: Sample size can be specified only as a number of rows for now.
          enum:
          - rows
          type: string
          x-versionadded: v2.27
        value:
          description: Number of rows to ingest during dataset registration.
          exclusiveMinimum: true
          maximum: 1000000
          minimum: 0
          type: integer
          x-versionadded: v2.27
      required:
      - type
      - value
      type: object
    AdvancedTuningArgumentsRetrieveResponse:
      properties:
        tuningDescription:
          description: Human-readable description of the tuned model, if specified
            by the user. `null` if unspecified.
          nullable: true
          type: string
        tuningParameters:
          description: An array of objects containing information about tuning parameters
            that are supported by the specified model.
          items:
            $ref: '#/components/schemas/TuningParameters'
          type: array
      required:
      - tuningDescription
      - tuningParameters
      type: object
    AggregateDirectiveArguments:
      properties:
        aggregations:
          description: The aggregations.
          items:
            $ref: '#/components/schemas/Aggregation'
          minItems: 1
          type: array
          x-versionadded: v2.33
        groupBy:
          description: The column(s) to group by.
          items:
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - aggregations
      - groupBy
      type: object
    Aggregation:
      properties:
        feature:
          default: null
          description: The feature.
          nullable: true
          type: string
          x-versionadded: v2.33
        functions:
          description: The functions.
          items:
            enum:
            - sum
            - min
            - max
            - count
            - count-distinct
            - stddev
            - avg
            - most-frequent
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - functions
      type: object
    Aim:
      properties:
        accuracyOptimizedMb:
          description: Include additional, longer-running models that will be run
            by the autopilot and available to run manually.
          type: boolean
        aggregationType:
          description: For multiseries projects only. The aggregation type to apply
            when creating cross-series features.
          enum:
          - total
          - average
          type: string
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          description: Specifies whether the time series predictions can use partial
            historical data.
          type: boolean
          x-versionadded: v2.24
        allowedPairwiseInteractionGroups:
          description: For GAM models - specify groups of columns for which pairwise
            interactions will be allowed. E.g. if set to [['A', 'B', 'C'], ['C', 'D']]
            then GAM models will allow interactions between columns AxB, BxC, AxC,
            CxD. All others (AxD, BxD) will not be considered. If not specified -
            all possible interactions will be considered by model.
          items:
            items:
              type: string
            maxItems: 10
            minItems: 2
            type: array
          maxItems: 100
          nullable: true
          type: array
          x-versionadded: v2.20
        allowedPairwiseInteractionGroupsFilename:
          description: Filename that was used to upload allowed_pairwise_interaction_groups.
            Necessary for persistence of UI/UX when you specify that parameter via
            file.
          nullable: true
          type: string
          x-versionadded: v2.20
        autopilotClusterList:
          description: A list of integers where each value will be used as the number
            of clusters in Autopilot model(s) for unsupervised clustering projects.
            Cannot be specified unless `unsupervisedMode` is true and `unsupervisedType`
            is set to `clustering`.
          items:
            maximum: 100
            minimum: 2
            type: integer
          maxItems: 10
          nullable: true
          type: array
          x-versionadded: v2.25
        autopilotDataSamplingMethod:
          description: Defines how autopilot will select subsample from training dataset
            in OTV/TS projects. Defaults to 'latest' for 'rowCount' dataSelectionMethod
            and to 'random' for 'duration'.
          enum:
          - random
          - latest
          type: string
        autopilotDataSelectionMethod:
          default: duration
          description: The Data Selection method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - duration
          - rowCount
          type: string
        autopilotWithFeatureDiscovery:
          description: If true, autopilot will run on a feature list that includes
            features found via search for interactions.
          type: boolean
        backtests:
          description: An array specifying the format of the backtests.
          items:
            $ref: '#/components/schemas/Backtest'
          maxItems: 50
          minItems: 1
          type: array
        biasMitigationFeatureName:
          description: The name of the protected feature used to mitigate bias on
            models.
          minLength: 1
          type: string
          x-versionadded: v2.27
        biasMitigationTechnique:
          description: Method applied to perform bias mitigation.
          enum:
          - preprocessingReweighing
          - postProcessingRejectionOptionBasedClassification
          type: string
          x-versionadded: v2.27
        blendBestModels:
          description: Blend best models during Autopilot run. This option is not
            supported in SHAP-only mode or for multilabel projects.
          type: boolean
          x-versionadded: v2.19
        blueprintThreshold:
          description: The runtime (in hours) which if exceeded will exclude a model
            from autopilot runs.
          maximum: 1440
          minimum: 1
          nullable: true
          type: integer
        calendarId:
          description: The ID of the calendar to be used in this project.
          type: string
          x-versionadded: v2.15
        chunkDefinitionId:
          description: Chunk definition id for incremental learning using chunking
            service
          type: string
          x-versionadded: v2.33
        classMappingAggregationSettings:
          $ref: '#/components/schemas/ClassMappingAggregationSettings'
          default: {}
          description: Class mapping aggregation settings.
        considerBlendersInRecommendation:
          description: Include blenders when selecting a model to prepare for deployment
            in an Autopilot Run. This option is not supported in SHAP-only mode or
            for multilabel projects.
          type: boolean
          x-versionadded: v2.21
        credentials:
          description: List of credentials for the secondary datasets used in feature
            discovery project.
          items:
            oneOf:
            - $ref: '#/components/schemas/PasswordCredentials'
            - $ref: '#/components/schemas/CredentialId'
          maxItems: 30
          type: array
          x-versionadded: v2.19
        crossSeriesGroupByColumns:
          description: For multiseries projects with cross-series features enabled
            only. List of columns (currently of length 1). Setting that indicates
            how to further split series into related groups. For example, if every
            series is sales of an individual product, the series group-by could be
            the product category with values like "men's clothing", "sports equipment",
            etc.
          items:
            type: string
          maxItems: 1
          type: array
          x-versionadded: v2.15
        cvHoldoutLevel:
          anyOf:
          - type: string
          - type: integer
          - type: number
          description: The value of the partition column indicating a row is part
            of the holdout set. This level is optional - if not specified or if provided
            as ``null``, then no holdout will be used in the project. The rest of
            the levels indicate which cross validation fold each row should fall into.
          nullable: true
        cvMethod:
          description: The partitioning method to be applied to the training data.
          enum:
          - random
          - user
          - stratified
          - group
          - datetime
          type: string
        dateRemoval:
          description: If true, enable creating additional feature lists without dates
            (does not apply to time-aware projects).
          type: boolean
          x-versionadded: v2.21
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column.
          type: string
        datetimePartitioningId:
          description: The ID of a datetime partitioning to use for the project.When
            datetime_partitioning_id is specified, no other datetime partitioning
            related field is allowed to be specified, as these fields get loaded from
            the already created partitioning.
          type: string
          x-versionadded: v2.30
        defaultToAPriori:
          description: Renamed to `defaultToKnownInAdvance`.
          type: boolean
          x-versiondeprecated: v2.11
        defaultToDoNotDerive:
          description: For time series projects only. Sets whether all features default
            to being treated as do-not-derive features, excluding them from feature
            derivation. Individual features can be set to a value different than the
            default by using the `featureSettings` parameter.
          type: boolean
          x-versionadded: v2.17
        defaultToKnownInAdvance:
          description: For time series projects only. Sets whether all features default
            to being treated as known in advance features, which are features that
            are known into the future. Features marked as known in advance must be
            specified into the future when making predictions. The default is false,
            all features are not known in advance. Individual features can be set
            to a value different than the default using the `featureSettings` parameter.
            See the :ref:`Time Series Overview <time_series_overview>` for more context.
          type: boolean
          x-versionadded: v2.11
        differencingMethod:
          description: For time series projects only. Used to specify which differencing
            method to apply if the data is stationary. For classification problems
            `simple` and `seasonal` are not allowed. Parameter `periodicities` must
            be specified if `seasonal` is chosen. Defaults to `auto`.
          enum:
          - auto
          - none
          - simple
          - seasonal
          type: string
          x-versionadded: v2.9
        disableHoldout:
          default: false
          description: Whether to suppress allocating a holdout fold. If `disableHoldout`
            is set to true, `holdoutStartDate` and `holdoutDuration` must not be set.
          type: boolean
          x-versionadded: v2.8
        eventsCount:
          description: The name of a column specifying events count. The data in this
            column must be pure numeric and non negative without missing values
          type: string
        exponentiallyWeightedMovingAlpha:
          description: Discount factor (alpha) used for exponentially weighted moving
            features
          maximum: 1.0
          minimum: 0.0
          type: number
        exposure:
          description: The name of a column specifying row exposure.The data in this
            column must be pure numeric (e.g. not currency, date, length, etc.) and
            without missing values
          type: string
        externalPredictions:
          description: List of external prediction columns from the dataset.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.26
        externalTimeSeriesBaselineDatasetId:
          description: Catalog version id for external prediction data that can be
            used as a baseline to calculate new metrics.
          type: string
          x-versionadded: v2.24
        externalTimeSeriesBaselineDatasetName:
          description: The name of the time series baseline dataset for the project.
          nullable: true
          type: string
          x-versionadded: v2.24
        fairnessMetricsSet:
          description: Metric to use for calculating fairness. Can be one of ``proportionalParity``,
            ``equalParity``, ``predictionBalance``, ``trueFavorableAndUnfavorableRateParity``
            or ``FavorableAndUnfavorablePredictiveValueParity``. Used and required
            only if *Bias & Fairness in AutoML* feature is enabled.
          enum:
          - proportionalParity
          - equalParity
          - predictionBalance
          - trueFavorableAndUnfavorableRateParity
          - favorableAndUnfavorablePredictiveValueParity
          type: string
          x-versionadded: v2.24
        fairnessThreshold:
          description: 'Threshold value of the fairness metric. Can be in a range
            of ``[0:1]``. If the actual metric value is below the threshold, the user
            will be notified '
          maximum: 1
          minimum: 0
          type: number
          x-versionadded: v2.24
        featureDerivationWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should end.
          maximum: 0
          type: integer
          x-versionadded: v2.8
        featureDerivationWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should begin.
          maximum: 0
          type: integer
          x-versionadded: v2.8
        featureDiscoverySupervisedFeatureReduction:
          description: Run supervised feature reduction for feature discovery projects.
          type: boolean
          x-versionadded: v2.21
        featureEngineeringPredictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          nullable: true
          type: string
          x-versionadded: v2.20
        featureSettings:
          description: An array specifying per feature settings. Features can be left
            unspecified.
          items:
            $ref: '#/components/schemas/FeatureSetting'
          type: array
        featurelistId:
          description: The ID of a featurelist to use for autopilot.
          type: string
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          type: integer
          x-versionadded: v2.8
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          type: integer
          x-versionadded: v2.8
        gapDuration:
          description: The duration of the gap between holdout training and holdout
            scoring data. For time series projects, defaults to the duration of the
            gap between the end of the feature derivation window and the beginning
            of the forecast window. For OTV projects, defaults to a zero duration
            (P0Y0M0D).
          format: duration
          type: string
        holdoutDuration:
          description: The duration of holdout scoring data. When specifying `holdoutDuration`,
            `holdoutStartDate` must also be specified. This attribute cannot be specified
            when `disableHoldout` is true.
          format: duration
          type: string
        holdoutEndDate:
          description: The end date of holdout scoring data. When specifying `holdoutEndDate`,
            `holdoutStartDate` must also be specified. This attribute cannot be specified
            when `disableHoldout` is true.
          format: date-time
          type: string
        holdoutLevel:
          anyOf:
          - type: string
          - type: integer
          - type: number
          description: The value of the partition column indicating a row is part
            of the holdout set. This level is optional - if not specified or if provided
            as ``null``, then no holdout will be used in the project. However, the
            column must have exactly 2 values in order for this option to be valid
        holdoutPct:
          description: The percentage of the dataset to assign to the holdout set
          maximum: 98
          minimum: 0
          type: number
        holdoutStartDate:
          description: The start date of holdout scoring data. When specifying `holdoutStartDate`,
            one of `holdoutEndDate` or `holdoutDuration` must also be specified. This
            attribute cannot be specified when `disableHoldout` is true.
          format: date-time
          type: string
        includeBiasMitigationFeatureAsPredictorVariable:
          description: Specifies whether the mitigation feature will be used as a
            predictor variable (i.e., treated like other categorical features in the
            input to train the modeler), in addition to being used for bias mitigation.
            If false, the mitigation feature will be used only for bias mitigation,
            and not for training the modeler task.
          type: boolean
          x-versionadded: v2.27
        incrementalLearningEarlyStoppingRounds:
          description: Early stopping rounds for the auto incremental learning service
          minimum: 0
          type: integer
          x-versionadded: v2.33
        incrementalLearningOnBestModel:
          description: Automatically run incremental learning on the best model during
            Autopilot run.
          type: boolean
          x-versionadded: v2.33
        incrementalLearningOnlyMode:
          description: Keep only models that support incremental learning during Autopilot
            run.
          type: boolean
          x-versionadded: v2.33
        isHoldoutModified:
          description: A boolean value indicating whether holdout settings (start/end
            dates) have been modified by user.
          type: boolean
        majorityDownsamplingRate:
          description: The percentage between 0 and 100 of the majority rows that
            should be kept. Must be specified only if using smart downsampling. If
            not specified, a default will be selected based on the dataset distribution.
            The chosen rate may not cause the majority class to become smaller than
            the minority class.
          type: number
        metric:
          description: The metric to use to select the best models. See `/api/v2/projects/(projectId)/features/metrics/`
            for the metrics that may be valid for a potential target.  Note that weighted
            metrics must be used with a weights column.
          type: string
        minSecondaryValidationModelCount:
          description: Compute 'All backtest' scores (datetime models) or cross validation
            scores for the specified number of highest ranking models on the Leaderboard,
            if over the Autopilot default.
          maximum: 10
          minimum: 0
          type: integer
          x-versionadded: v2.19
        mode:
          description: The autopilot mode to use.  Either 'quick', 'auto', 'manual'
            or 'comprehensive'
          enum:
          - '0'
          - '2'
          - '4'
          - '3'
          - auto
          - manual
          - comprehensive
          - quick
          type: string
        modelBaselines:
          description: An array of strings with names of a columns specifying rowbaselines.
            Columns values are used as offset or predictions to boost for models.
            The data in this column must be pure numeric (e.g. not currency,date,
            length, etc.).
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.31
        modelGroupId:
          description: The name of a column specifying the model group ID to which
            each row of the datasetbelongs. Typically the model group ID was used
            to derive the additional features, that are independent from each other.
            Column unique values are used to subset the modeling data and build a
            separate model for each unique column value.Similar to time series this
            column is well suited to be used as multi-series ID column.
          type: string
          x-versionadded: v2.31
        modelRegimeId:
          description: The name of a column specifying the model regime ID to which
            each row of the datasetbelongs. Column unique values are used to subset
            the modeling data and build a separate model for each unique column value.
            Similar to time series this column is well suited to be used as forecast
            distance.
          type: string
          x-versionadded: v2.31
        modelSplits:
          default: 5
          description: 'Sets the cap on the number of jobs per model used when building
            models to control number of jobs in the queue. Higher number of modelSplits
            will allow for less downsampling leading to the use of more post-processed
            data. '
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.21
        monotonicDecreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target.  If null,
            no such constraints are enforced. When specified, this will set a default
            for the project that can be overriden at model submission time if desired.
          nullable: true
          type: string
        monotonicIncreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced. When specified, this will set a default
            for the project that can be overriden at model submission time if desired.
          nullable: true
          type: string
        multiseriesIdColumns:
          description: May be used only with time series projects. An array of the
            column names identifying  the series to which each row of the dataset
            belongs. Currently only one multiseries ID column is supported. See the
            :ref:`multiseries <multiseries>` section of the time series documentation
            for more context.
          items:
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.11
        numberOfBacktests:
          description: The number of backtests to use. If omitted, defaults to a positive
            value selected by the server based on the validation and gap durations.
          type: integer
        offset:
          description: An array of strings with names of a columns specifying row
            offsets.The data in this column must be pure numeric (e.g. not currency,
            date, length, etc.) and without missing values
          items:
            type: string
          type: array
        onlyIncludeMonotonicBlueprints:
          default: false
          description: When true, only blueprints that support enforcing montonic
            constraints will be available in the project or selected for autopilot.
          type: boolean
        partitionKeyCols:
          description: An array containing a single string - the name of the group
            partition column
          items:
            type: string
          type: array
        periodicities:
          description: A list of periodicities for time series projects only. For
            classification problems periodicities are not allowed. If this is provided,
            parameter 'differencing_method' will default to 'seasonal' if not provided
            or 'auto'.
          items:
            $ref: '#/components/schemas/Periodicity'
          type: array
        positiveClass:
          anyOf:
          - type: string
          - type: integer
          - type: number
          description: A value from the target column to use for the positive class.
            May only be specified for projects doing binary classification.If not
            specified, a positive class is selected automatically.
        preferableTargetValue:
          anyOf:
          - type: string
          - type: integer
          - type: number
          description: A target value that should be treated as a positive outcome
            for the prediction. For example if we want to check gender discrimination
            for giving a loan and our target named ``is_bad``, then the positive outcome
            for the prediction would be ``No``, which means that the loan is good
            and that's what we treat as a preferable result for the loaner. Used and
            required only if *Bias & Fairness in AutoML* feature is enabled.
          x-versionadded: v2.24
        prepareModelForDeployment:
          description: Prepare model for deployment during Autopilot run. The preparation
            includes creating reduced feature list models, retraining best model on
            higher sample size, computing insights and assigning 'RECOMMENDED FOR
            DEPLOYMENT' label.
          type: boolean
          x-versionadded: v2.19
        primaryLocationColumn:
          description: Primary geospatial location column.
          nullable: true
          type: string
        protectedFeatures:
          description: A list of project feature to mark as protected for Bias metric
            calculation and Fairness correction. Used and required only if *Bias &
            Fairness in AutoML* feature is enabled.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.24
        quantileLevel:
          description: The quantile level between 0.01 and 0.99 for specifying the
            Quantile metric.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.22
        quickrun:
          description: '(Deprecated): ''quick'' should be used in the `mode` parameter
            instead of using this parameter. If set to `true`, autopilot mode will
            be set to ''quick''.Cannot be set to `true` when `mode` is set to ''comprehensive''
            or ''manual''.'
          type: boolean
          x-versiondeprecated: v2.21
        rateTopPctThreshold:
          description: The percentage threshold between 0.1 and 50 for specifying
            the Rate@Top% metric.
          maximum: 100.0
          minimum: 0.0
          type: number
        relationshipsConfigurationId:
          description: Relationships configuration id to be used for Feature Discovery
            projects.
          nullable: true
          type: string
          x-versionadded: v2.21
        reps:
          description: The number of cross validation folds to use.
          maximum: 999999
          minimum: 2
          type: integer
        responseCap:
          description: Used to cap the maximum response of a model
          maximum: 1
          minimum: 0.5
          type: number
        runLeakageRemovedFeatureList:
          description: Run Autopilot on Leakage Removed feature list (if exists).
          type: boolean
          x-versionadded: v2.21
        sampleStepPct:
          description: 'A float between 0 and 100 indicating the desired percentage
            of data to sample when training models in comprehensive Autopilot. Note:
            this only supported for comprehensive Autopilot and the specified value
            may be lowered in order to be compatible with the project''s dataset and
            partition settings.'
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: number
          x-versionadded: v2.20
        scoringCodeOnly:
          description: Keep only models that can be converted to scorable java code
            during Autopilot run.
          type: boolean
          x-versionadded: v2.19
        seed:
          description: A seed to use for randomization.
          maximum: 999999999
          minimum: 0
          type: integer
        segmentationTaskId:
          description: Specifies the SegmentationTask that will be used for dividing
            the project up into multiple segmented projects.
          nullable: true
          type: string
          x-versionadded: v2.24
        shapOnlyMode:
          description: Keep only models that support SHAP values during Autopilot
            run. Use SHAP-based insights wherever possible.
          type: boolean
          x-versionadded: v2.21
        smartDownsampled:
          description: Whether to use smart downsampling to throw away excess rows
            of the majority class. Only applicable to classification and zero-boosted
            regression projects.
          type: boolean
        stopWords:
          description: 'A list of stop words to be used for text blueprints. Note:
            ``stop_words=True`` must be set in the blueprint preprocessing parameters
            for this list of stop words to actually be used during preprocessing.'
          items:
            maxLength: 100
            type: string
          maxItems: 1000
          type: array
          x-versionadded: v2.21
        target:
          description: The name of the target feature.
          type: string
        targetType:
          description: Used to specify the targetType to use for a project when it
            is ambiguous, i.e. a numeric target with a few unique values that could
            be used for either regression or multiclass.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Multilabel
          type: string
        trainingLevel:
          anyOf:
          - type: string
          - type: integer
          - type: number
          description: The value of the partition column indicating a row is part
            of the training set.
        treatAsExponential:
          default: auto
          description: For time series projects only. Used to specify whether to treat
            data as exponential trend and apply transformations like log-transform.
            For classification problems `always` is not allowed.
          enum:
          - auto
          - never
          - always
          type: string
        unsupervisedMode:
          default: false
          description: If True, unsupervised project (without target) will be created.
            ``target`` cannot be specified if ``unsupervisedMode`` is True.
          type: boolean
          x-versionadded: v2.20
        unsupervisedType:
          description: The type of unsupervised project. Only valid when `unsupervisedMode`
            is true. If `unsupervisedMode`, defaults to `anomaly`.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.23
        useCrossSeriesFeatures:
          description: Indicating if user wants to use cross-series features.
          type: boolean
        useGpu:
          description: Indicates whether project should use GPU workers
          type: boolean
          x-versionadded: v2.31
        useProjectSettings:
          description: Specifies whether datetime-partitioned project should use project
            settings (i.e. backtests configuration has been modified by the user).
          type: boolean
          x-versionadded: v2.25
        useSupervisedFeatureReduction:
          default: true
          description: When true, during feature generation DataRobot runs a supervised
            algorithm that identifies those features with predictive impact on the
            target and builds feature lists using only qualifying features. Setting
            false can severely impact autopilot duration, especially for datasets
            with many features.
          type: boolean
        useTimeSeries:
          default: false
          description: A boolean value indicating whether a time series project should
            be created instead of a regular project which uses datetime partitioning.
          type: boolean
          x-versionadded: v2.8
        userPartitionCol:
          description: The name of the column containing the partition assignments.
          type: string
        validationDuration:
          description: The default validation duration for all backtests. If the primary
            date/time feature in a time series project is irregular, you cannot set
            a default validation length. Instead, set each duration individually.
            For an OTV project setting the validation duration will always use regular
            partitioning. Omitting it will use irregular partitioning if the date/time
            feature is irregular.
          format: duration
          type: string
        validationLevel:
          anyOf:
          - type: string
          - type: integer
          - type: number
          description: The value of the partition column indicating a row is part
            of the validation set.
        validationPct:
          description: The percentage of the dataset to assign to the validation set
          maximum: 99
          minimum: 0
          type: number
        validationType:
          description: The validation method to be used.  CV for cross validation
            or TVH for train-validation-holdout split.
          enum:
          - CV
          - TVH
          type: string
        weights:
          description: The name of a column specifying row weights. The data in this
            column must be pure numeric (e.g. not currency, date, length, etc.) and
            without missing values
          type: string
        windowsBasisUnit:
          description: For time series projects only. Indicates which unit is basis
            for feature derivation window and forecast window. Valid options are detected
            time unit or `ROW`. If omitted, the default value is detected time unit.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          type: string
          x-versionadded: v2.14
      required:
      - autopilotDataSelectionMethod
      - onlyIncludeMonotonicBlueprints
      type: object
    AllDataImage:
      properties:
        images:
          description: A list of b64 encoded images.
          items:
            description: b64 encoded image
            type: string
          maxItems: 10
          minItems: 1
          type: array
        percentageOfMissingImages:
          description: A percentage of image rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          type: number
      required:
      - images
      - percentageOfMissingImages
      type: object
    AllDataText:
      properties:
        missingRowsPercent:
          description: A percentage of all rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        perValueStatistics:
          description: Statistic value for feature values in all data or a cluster.
          items:
            $ref: '#/components/schemas/PerValueStatisticTextListItem'
          type: array
      required:
      - perValueStatistics
      type: object
    AllMulticlassModelLiftChartsResponse:
      properties:
        charts:
          description: List of lift chart data from all available sources.
          items:
            $ref: '#/components/schemas/MulticlassModelLiftChartResponse'
          type: array
      required:
      - charts
      type: object
    AllowExtra:
      type: object
    AnalyzedFeature:
      properties:
        detailsHistogram:
          description: Histogram details for the specified feature.
          items:
            $ref: '#/components/schemas/HistogramDetails'
          type: array
        disparityScore:
          description: A number to describe disparity for the feature between the
            compared classes.
          type: number
        featureImpact:
          description: A feature importance value.
          type: number
        name:
          description: Name of the feature.
          type: string
        status:
          description: A status of the feature.
          enum:
          - Healthy
          - At Risk
          - Failing
          type: string
      required:
      - detailsHistogram
      - disparityScore
      - featureImpact
      - name
      - status
      type: object
    AnomalyAssessmentExplanationsResponse:
      properties:
        backtest:
          description: The backtest of the record.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
        count:
          description: The count of points.
          type: integer
        data:
          description: Each is a `DataPoint` corresponding to a row in the specified
            range.
          items:
            $ref: '#/components/schemas/DataPointResponse'
          type: array
        endDate:
          description: 'ISO-formatted last timestamp in the response. For example:
            ``2019-08-30T00:00:00.000000Z``.'
          format: date-time
          type: string
        modelId:
          description: The model ID of the record.
          type: string
        projectId:
          description: The project ID of the record.
          type: string
        recordId:
          description: The ID of the anomaly assessment record.
          type: string
        seriesId:
          description: The series id of the record. Applicable in multiseries projects
          nullable: true
          type: string
        shapBaseValue:
          description: shap base value
          type: number
        source:
          description: The source of the record
          enum:
          - training
          - validation
          type: string
        startDate:
          description: 'ISO-formatted first timestamp in the response. For example:
            ``2019-08-01T00:00:00.000000Z``.'
          format: date-time
          type: string
      required:
      - backtest
      - count
      - data
      - endDate
      - modelId
      - projectId
      - recordId
      - seriesId
      - shapBaseValue
      - source
      - startDate
      type: object
    AnomalyAssessmentInitialize:
      properties:
        backtest:
          description: The backtest to compute insight for.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
        seriesId:
          description: Required for multiseries projects. The series id to compute
            insight for.
          type: string
        source:
          description: The source to compute insight for.
          enum:
          - training
          - validation
          type: string
      required:
      - backtest
      - source
      type: object
    AnomalyAssessmentPreviewResponse:
      properties:
        backtest:
          description: The backtest of the record.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
        endDate:
          description: 'ISO-formatted last timestamp in the subset. For example: ``2019-08-30T00:00:00.000000Z``.'
          format: date-time
          type: string
        modelId:
          description: The model ID of the record.
          type: string
        previewBins:
          description: Aggregated predictions for the subset. Bins boundaries may
            differ from actual start/end dates because this is an aggregation.
          items:
            $ref: '#/components/schemas/BinResponse'
          type: array
        projectId:
          description: The project ID of the record.
          type: string
        recordId:
          description: The ID of the anomaly assessment record.
          type: string
        seriesId:
          description: The series id of the record. Applicable in multiseries projects
          nullable: true
          type: string
        source:
          description: The source of the record
          enum:
          - training
          - validation
          type: string
        startDate:
          description: 'ISO-formatted first timestamp in the subset. For example:
            ``2019-08-01T00:00:00.000000Z``.'
          format: date-time
          type: string
      required:
      - backtest
      - endDate
      - modelId
      - previewBins
      - projectId
      - recordId
      - seriesId
      - source
      - startDate
      type: object
    AnomalyAssessmentRecordResponse:
      properties:
        backtest:
          description: The backtest of the record.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
        deleteLocation:
          description: URL to delete anomaly assessment record.
          format: uri
          nullable: true
          type: string
        endDate:
          description: 'ISO-formatted last timestamp in the subset. For example: ``2019-08-30T00:00:00.000000Z``.'
          format: date-time
          nullable: true
          type: string
        latestExplanationsLocation:
          description: URL to retrieve the latest predictions with the shap explanations.
          format: uri
          nullable: true
          type: string
        modelId:
          description: The model ID of the record.
          type: string
        predictionThreshold:
          description: The threshold, all rows with anomaly scores greater or equal
            to it have Shapley explanations computed.
          nullable: true
          type: number
        previewLocation:
          description: URL to retrieve predictions preview for the record.
          format: uri
          nullable: true
          type: string
        projectId:
          description: The project ID of the record.
          type: string
        recordId:
          description: The ID of the anomaly assessment record.
          type: string
        seriesId:
          description: The series id of the record. Applicable in multiseries projects
          nullable: true
          type: string
        source:
          description: The source of the record
          enum:
          - training
          - validation
          type: string
        startDate:
          description: 'ISO-formatted first timestamp in the subset. For example:
            ``2019-08-01T00:00:00.000000Z``.'
          format: date-time
          nullable: true
          type: string
        status:
          description: The status of the anomaly assessment record.
          enum:
          - noData
          - notSupported
          - completed
          type: string
        statusDetails:
          description: The status details.
          type: string
      required:
      - backtest
      - deleteLocation
      - endDate
      - latestExplanationsLocation
      - modelId
      - predictionThreshold
      - previewLocation
      - projectId
      - recordId
      - seriesId
      - source
      - startDate
      - status
      - statusDetails
      type: object
    AnomalyAssessmentRecordsResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: Anomaly assessment record.
          items:
            $ref: '#/components/schemas/AnomalyAssessmentRecordResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    AnomalyInsightTableData:
      properties:
        columns:
          description: array of columns that contain columns from training dataset
            and `anomalyScore` column.
          items:
            type: string
          type: array
        data:
          description: array of arrays with actual data. Order in each array corresponds
            to order in columns array.
          items:
            type: number
          type: array
        rowId:
          description: index 0-based array. Each rowId corresponds to the actual row
            number of training data
          items:
            type: integer
          type: array
      required:
      - columns
      - data
      - rowId
      type: object
    AnomalyInsightTableRetrieve:
      properties:
        modelId:
          description: given model identifier
          type: string
        table:
          description: anomaly insights table
          items:
            $ref: '#/components/schemas/AnomalyInsightTableData'
          type: array
      required:
      - modelId
      - table
      type: object
    AnomalyOverTimePlotsBins:
      properties:
        endDate:
          description: 'The datetime of the end of the bin (exclusive). '
          format: date-time
          type: string
        frequency:
          description: Indicates number of values averaged in bin in case of a resolution
            change.
          nullable: true
          type: integer
        predicted:
          description: Average prediction of the model in the bin. `null` if there
            are no entries in the bin.
          nullable: true
          type: number
        startDate:
          description: 'The datetime of the start of the bin (inclusive). '
          format: date-time
          type: string
      required:
      - endDate
      - frequency
      - predicted
      - startDate
      type: object
    AnomalyOverTimePlotsDataResponse:
      properties:
        bins:
          description: An array of bins for the retrieved plots.
          items:
            $ref: '#/components/schemas/AnomalyOverTimePlotsBins'
          maxItems: 1000
          minItems: 1
          type: array
        calendarEvents:
          description: An array of calendar events for a retrieved plot.
          items:
            $ref: '#/components/schemas/CalendarEvent'
          maxItems: 1000
          type: array
        endDate:
          description: 'The datetime of the end of the chart data (exclusive). '
          format: date-time
          type: string
        resolution:
          description: The resolution that is used for binning.
          enum:
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
        startDate:
          description: 'The datetime of the start of the chart data (inclusive). '
          format: date-time
          type: string
      required:
      - bins
      - calendarEvents
      - endDate
      - resolution
      - startDate
      type: object
    AnomalyOverTimePlotsMetadataResponse:
      properties:
        backtestMetadata:
          description: An array of metadata information for each backtest. The array
            index of metadata object is the backtest index.
          items:
            $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
          maxItems: 20
          minItems: 1
          type: array
        backtestStatuses:
          description: An array of status information for each backtest. The array
            index of status object is the backtest index.
          items:
            $ref: '#/components/schemas/AccuracyOverTimePlotsStatus'
          maxItems: 20
          minItems: 1
          type: array
        estimatedSeriesLimit:
          description: Estimated number of series that can be calculated in one request
            for 1 FD.
          minimum: 1
          type: integer
        holdoutMetadata:
          $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
          description: Metadata information for holdout.
        holdoutStatuses:
          $ref: '#/components/schemas/AccuracyOverTimePlotsStatus'
          description: Status information for holdout.
        resolutions:
          description: An array of available time resolutions for which plots can
            be retrieved.
          items:
            enum:
            - milliseconds
            - seconds
            - minutes
            - hours
            - days
            - weeks
            - months
            - quarters
            - years
            type: string
          maxItems: 9
          minItems: 1
          type: array
      required:
      - backtestMetadata
      - backtestStatuses
      - holdoutMetadata
      - holdoutStatuses
      - resolutions
      type: object
    AnomalyOverTimePlotsPreviewBins:
      properties:
        endDate:
          description: 'The datetime of the end of the bin (exclusive). '
          format: date-time
          type: string
        startDate:
          description: 'The datetime of the start of the bin (inclusive). '
          format: date-time
          type: string
      required:
      - endDate
      - startDate
      type: object
    AnomalyOverTimePlotsPreviewResponse:
      properties:
        bins:
          description: An array of bins for the retrieved plots.
          items:
            $ref: '#/components/schemas/AnomalyOverTimePlotsPreviewBins'
          maxItems: 1000
          type: array
        endDate:
          description: 'The datetime of the end of the chart data (exclusive). '
          format: date-time
          type: string
        predictionThreshold:
          description: Only bins with predictions exceeding this threshold are returned
            in the response.
          exclusiveMinimum: true
          maximum: 1
          minimum: 0
          type: number
        startDate:
          description: 'The datetime of the start of the chart data (inclusive). '
          format: date-time
          type: string
      required:
      - bins
      - endDate
      - predictionThreshold
      - startDate
      type: object
    Application:
      properties:
        applicationTemplateType:
          description: Application template type, purpose
          nullable: true
          type: string
        applicationTypeId:
          description: The ID of the type of the application
          type: string
        cloudProvider:
          description: The host of this application
          type: string
        createdAt:
          description: The timestamp when the application was created
          type: string
        createdBy:
          description: The username of who created the application
          type: string
        creatorFirstName:
          description: Application creator first name
          nullable: true
          type: string
        creatorLastName:
          description: Application creator last name
          nullable: true
          type: string
        creatorUserhash:
          description: Application creator userhash
          nullable: true
          type: string
        datasets:
          description: The list of datasets IDs associated with the application
          items:
            type: string
          type: array
        deactivationStatusId:
          description: The ID of the status object to track the asynchronous app deactivation
            process status. Will be null if the app was never deactivated.
          nullable: true
          type: string
        deploymentIds:
          description: A list of deployment IDs for this app
          items:
            description: The ID of one deployment
            type: string
          type: array
        deploymentName:
          description: Name of the deployment
          nullable: true
          type: string
        deploymentStatusId:
          description: ' The ID of the status object to track the asynchronous deployment
            process status'
          type: string
        deployments:
          description: A list of deployment details
          items:
            $ref: '#/components/schemas/ApplicationDeployment'
          nullable: true
          type: array
        description:
          description: A description of the application
          type: string
        hasCustomLogo:
          description: Whether the app has a custom logo
          type: boolean
        id:
          description: The ID of the created application
          type: string
        modelDeploymentId:
          description: The ID of the associated model deployment
          type: string
        name:
          description: The name of the application
          type: string
        orgId:
          description: ID of the app's organization
          type: string
        orgName:
          description: Name of the app's organization
          nullable: true
          type: string
        permissions:
          description: The list of permitted actions, which the authenticated user
            can perform on this application.
          items:
            enum:
            - CAN_DELETE
            - CAN_SHARE
            - CAN_UPDATE
            - CAN_VIEW
            type: string
          type: array
        poolUsed:
          description: Whether the pool where used for last app deployment
          type: boolean
        relatedEntities:
          $ref: '#/components/schemas/ApplicationRelatedEntities'
          description: IDs of entities, related to app for easy search
          nullable: true
        updatedAt:
          description: The timestamp when the application was updated
          type: string
        userId:
          description: The ID of the user which created the application
          type: string
      required:
      - applicationTemplateType
      - applicationTypeId
      - cloudProvider
      - createdAt
      - createdBy
      - creatorFirstName
      - creatorLastName
      - creatorUserhash
      - datasets
      - deactivationStatusId
      - deploymentIds
      - deploymentName
      - deploymentStatusId
      - deployments
      - description
      - hasCustomLogo
      - id
      - modelDeploymentId
      - name
      - orgId
      - permissions
      - poolUsed
      - updatedAt
      - userId
      type: object
    ApplicationAccessControlData:
      properties:
        canShare:
          description: Whether this user can share with other users
          type: boolean
        role:
          description: The role of the user on this application
          type: string
        userId:
          description: The ID of the user
          type: string
        username:
          description: Username of a user with access to this application
          type: string
      required:
      - canShare
      - role
      - userId
      - username
      type: object
    ApplicationAccessControlList:
      properties:
        count:
          description: Number of items returned on this page
          type: integer
        data:
          description: An array of AccessControlData objects
          items:
            $ref: '#/components/schemas/ApplicationAccessControlData'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    ApplicationAccessControlUpdateRequest:
      properties:
        data:
          description: An array of AccessControlPermissionValidator objects
          items:
            $ref: '#/components/schemas/ApplicationAccessPermission'
          type: array
        permissions:
          description: The list of permission objects describing which users to modify
            access for.
          items:
            $ref: '#/components/schemas/ApplicationAccessPermission'
          type: array
      required:
      - data
      type: object
    ApplicationAccessPermission:
      properties:
        role:
          description: The role to grant to the user, or "" (empty string) to remove
            the users access
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - ''
          type: string
        username:
          description: The username of the user to modify access for
          type: string
      required:
      - role
      - username
      type: object
    ApplicationCanCreate:
      properties:
        experimentContainerId:
          description: The ID of the experiment container (for apps from an experiment
            container
          type: string
        projectId:
          description: The ID of the project (for apps from leaderboard)
          type: string
        sourceId:
          description: The ID of the source
          type: string
        sourceType:
          description: Whether the app is from a deployment or a project
          enum:
          - deployment
          - model
          type: string
      required:
      - sourceId
      - sourceType
      type: object
    ApplicationCreate:
      properties:
        applicationTypeId:
          description: The ID of the of application to be created.
          type: string
        authenticationType:
          default: invitedUsersOnly
          description: Authentication type
          enum:
          - invitedUsersOnly
          - token
          nullable: true
          type: string
        cloudProvider:
          default: drcloud
          description: The optional cloud provider
          enum:
          - drcloud
          - heroku
          type: string
        description:
          description: The description of the application
          maxLength: 512
          nullable: true
          type: string
        experimentContainerId:
          description: '[DEPRECATED - replaced with use_case_id] The ID of the experiment
            container associated with the application.'
          type: string
        modelDeploymentId:
          description: The ID of the model deployment. The deployed application will
            use this deployment to make predictions.
          type: string
        name:
          description: The name of the app
          maxLength: 512
          minLength: 1
          type: string
        purpose:
          description: An optional field to describe the purpose of the application.
          nullable: true
          type: string
        sources:
          description: The sources for this application
          items:
            $ref: '#/components/schemas/ApplicationCreateSources'
          type: array
        useCaseId:
          description: The ID of the Use Case associated with the application.
          type: string
      type: object
    ApplicationCreateSources:
      properties:
        info:
          description: Information about the Deployment or the Model
          oneOf:
          - $ref: '#/components/schemas/ApplicationDeploymentSource'
          - $ref: '#/components/schemas/ApplicationModelSource'
        name:
          description: The name of this source.
          type: string
        source:
          description: Information about the source for this application.
          enum:
          - deployment
          - model
          type: string
      required:
      - info
      - source
      type: object
    ApplicationDeployment:
      properties:
        deploymentId:
          description: The ID of the deployment
          type: string
        referenceName:
          description: The reference name of the deployment
          type: string
      required:
      - deploymentId
      - referenceName
      type: object
    ApplicationDeploymentSource:
      properties:
        modelDeploymentId:
          description: The ID of the model deployment
          type: string
      required:
      - modelDeploymentId
      type: object
    ApplicationDuplicate:
      properties:
        authenticationType:
          default: invitedUsersOnly
          description: Authentication type
          enum:
          - invitedUsersOnly
          - token
          nullable: true
          type: string
        description:
          description: The description of the application
          maxLength: 512
          nullable: true
          type: string
        duplicatePredictions:
          default: false
          description: Import all predictions from the source application
          type: boolean
        name:
          description: The name of the app
          maxLength: 512
          minLength: 1
          type: string
      type: object
    ApplicationList:
      properties:
        count:
          description: Number of items returned on this page
          type: integer
        data:
          description: An array of Application objects
          items:
            $ref: '#/components/schemas/Application'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    ApplicationModelDeploymentParam:
      properties:
        applicationId:
          description: The ID of the application
          type: string
        modelDeploymentId:
          description: The ID of the model deployment
          type: string
      required:
      - applicationId
      - modelDeploymentId
      type: object
    ApplicationModelSource:
      properties:
        modelId:
          description: The ID of the model
          type: string
        predictionThreshold:
          description: Threshold used for binary classification in predictions
          maximum: 1.0
          minimum: 0.0
          type: number
        projectId:
          description: The ID of the project
          type: string
      required:
      - modelId
      - projectId
      type: object
    ApplicationNameAndDescription:
      properties:
        description:
          description: The description of the application
          maxLength: 512
          nullable: true
          type: string
        name:
          description: The name of the app
          maxLength: 512
          minLength: 1
          type: string
      type: object
    ApplicationParam:
      properties:
        applicationId:
          description: The ID of the application
          type: string
      required:
      - applicationId
      type: object
    ApplicationRelatedEntities:
      properties:
        isFromExperimentContainer:
          description: '[DEPRECATED - replaced with is_from_use_case] Whether the
            app was created from an experiment container'
          type: boolean
        isFromUseCase:
          description: Whether the app was created from an Use Case
          type: boolean
        isTrialOrganization:
          description: Whether the app was created from by trial customer
          type: boolean
        modelId:
          description: The ID of the associated model
          type: string
        projectId:
          description: The ID of the associated project
          type: string
      type: object
    ApplicationRetrieve:
      properties:
        applicationTemplateType:
          description: Application template type, purpose
          nullable: true
          type: string
        applicationTypeId:
          description: The ID of the type of the application
          type: string
        cloudProvider:
          description: The host of this application
          type: string
        createdAt:
          description: The timestamp when the application was created
          type: string
        createdBy:
          description: The username of who created the application
          type: string
        creatorFirstName:
          description: Application creator first name
          nullable: true
          type: string
        creatorLastName:
          description: Application creator last name
          nullable: true
          type: string
        creatorUserhash:
          description: Application creator userhash
          nullable: true
          type: string
        datasets:
          description: The list of datasets IDs associated with the application
          items:
            type: string
          type: array
        deactivationStatusId:
          description: The ID of the status object to track the asynchronous app deactivation
            process status. Will be null if the app was never deactivated.
          nullable: true
          type: string
        deploymentIds:
          description: A list of deployment IDs for this app
          items:
            description: The ID of one deployment
            type: string
          type: array
        deploymentName:
          description: Name of the deployment
          nullable: true
          type: string
        deploymentStatusId:
          description: ' The ID of the status object to track the asynchronous deployment
            process status'
          type: string
        deployments:
          description: A list of deployment details
          items:
            $ref: '#/components/schemas/ApplicationDeployment'
          nullable: true
          type: array
        description:
          description: A description of the application
          type: string
        hasCustomLogo:
          description: Whether the app has a custom logo
          type: boolean
        id:
          description: The ID of the created application
          type: string
        modelDeploymentId:
          description: The ID of the model deployment. The deployed application will
            use this deployment to make predictions.
          nullable: true
          type: string
        name:
          description: The name of the application
          type: string
        orgId:
          description: ID of the app's organization
          type: string
        orgName:
          description: Name of the app's organization
          nullable: true
          type: string
        permissions:
          description: The list of permitted actions, which the authenticated user
            can perform on this application.
          items:
            enum:
            - CAN_DELETE
            - CAN_SHARE
            - CAN_UPDATE
            - CAN_VIEW
            type: string
          type: array
        poolUsed:
          description: Whether the pool where used for last app deployment
          type: boolean
        relatedEntities:
          $ref: '#/components/schemas/ApplicationRelatedEntities'
          description: IDs of entities, related to app for easy search
          nullable: true
        updatedAt:
          description: The timestamp when the application was updated
          type: string
        userId:
          description: The ID of the user which created the application
          type: string
      required:
      - applicationTemplateType
      - applicationTypeId
      - cloudProvider
      - createdAt
      - createdBy
      - creatorFirstName
      - creatorLastName
      - creatorUserhash
      - datasets
      - deactivationStatusId
      - deploymentIds
      - deploymentName
      - deploymentStatusId
      - deployments
      - description
      - hasCustomLogo
      - id
      - name
      - orgId
      - permissions
      - poolUsed
      - updatedAt
      - userId
      type: object
    ApplicationSharedRolesEntry:
      properties:
        id:
          description: The id of the receipient
          type: string
        name:
          description: The name of the user, group, or organization
          type: string
        role:
          description: The assigned role
          enum:
          - OWNER
          - USER
          - CONSUMER
          - EDITOR
          type: string
        shareRecipientType:
          description: The recipient type
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
    ApplicationSharedRolesEntryUpdate:
      properties:
        id:
          description: The id of the receipient
          type: string
        role:
          description: The assigned role
          enum:
          - OWNER
          - USER
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    ApplicationSharedRolesList:
      properties:
        count:
          description: Number of items returned on this page
          type: integer
        data:
          description: Details about the Shared Role entries
          items:
            $ref: '#/components/schemas/ApplicationSharedRolesEntry'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: Number of items matching to the query condition
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ApplicationSharingUpdateOrRemove:
      properties:
        note:
          default: ''
          description: A note to go with the project share
          type: string
        operation:
          description: Name of the action being taken. The only operation is 'updateRoles'.
          enum:
          - updateRoles
          type: string
        roles:
          description: Array of GrantAccessControl objects., up to maximum 100 objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/GrantAccessControlWithUsername'
            - $ref: '#/components/schemas/GrantAccessControlWithId'
          maxItems: 100
          minItems: 1
          type: array
        sendNotification:
          default: false
          description: Send a notification?
          type: boolean
      required:
      - operation
      - roles
      type: object
    ApplicationUserRoleResponse:
      properties:
        role:
          description: The role of the user on this entity.
          type: string
      required:
      - role
      type: object
    ApprovalPolicy:
      properties:
        active:
          default: true
          description: Whether this policy is active.
          type: boolean
        automaticAction:
          $ref: '#/components/schemas/ApprovalPolicyAutomaticAction'
          description: An object describing the automated action on the Change Request
            that will be performed if the request is not resolved within a given time
            period after its creation. If ``null``, no automated actions will be taken
            on the related Change Requests.
          nullable: true
        name:
          description: Name of the Approval Policy.
          maxLength: 50
          type: string
        review:
          $ref: '#/components/schemas/ApprovalPolicyReview'
          description: An object describing review requirements for Change Requests,
            related to a specific policy. If ``null``, no additional review requirements
            are added to the related Change Requests.
          nullable: true
        trigger:
          $ref: '#/components/schemas/ApprovalPolicyTrigger'
          description: An object describing the trigger for the Approval Policy.
      required:
      - active
      - name
      - trigger
      type: object
    ApprovalPolicyAutomaticAction:
      properties:
        action:
          description: Action of the workflow automation.
          enum:
          - cancel
          - Cancel
          - CANCEL
          - approve
          - Approve
          - APPROVE
          type: string
        period:
          description: Period (ISO 8601) after which an action is executed on a Change
            Request if it is not resolved or cancelled.
          format: duration
          type: string
      required:
      - action
      - period
      type: object
    ApprovalPolicyIntendedAction:
      properties:
        action:
          description: Type of action to trigger on.
          enum:
          - create
          - Create
          - CREATE
          - update
          - Update
          - UPDATE
          - delete
          - Delete
          - DELETE
          type: string
        condition:
          $ref: '#/components/schemas/ApprovalPolicyIntendedActionCondition'
          description: An object, describing the condition to trigger on.
          nullable: true
      required:
      - action
      type: object
    ApprovalPolicyIntendedActionCondition:
      properties:
        condition:
          description: Condition for the field content to trigger on.
          enum:
          - equals
          - Equals
          - EQUALS
          type: string
        fieldName:
          description: Name of the attribute of the entity to filter entities by.
            An example value is ``importance`` attribute for the deployment entity.
          maxLength: 50
          type: string
        values:
          description: Array of field values to apply condition to trigger on. If
            ``null`` for ``equals`` condition, then any value for the field is accepted.
          items:
            maxLength: 50
            type: string
          maxItems: 100
          nullable: true
          type: array
      required:
      - condition
      - fieldName
      - values
      type: object
    ApprovalPolicyListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of Approval Policies.
          items:
            $ref: '#/components/schemas/ApprovalPolicyResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ApprovalPolicyMatchResponse:
      properties:
        action:
          description: Searched policy action.
          enum:
          - create
          - Create
          - CREATE
          - update
          - Update
          - UPDATE
          - delete
          - Delete
          - DELETE
          type: string
        entityType:
          description: Searched typed of the entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - deploymentModel
          - DeploymentModel
          - DEPLOYMENT_MODEL
          - deploymentConfig
          - DeploymentConfig
          - DEPLOYMENT_CONFIG
          - deploymentStatus
          - DeploymentStatus
          - DEPLOYMENT_STATUS
          - deploymentMonitoringData
          - DeploymentMonitoringData
          - DEPLOYMENT_MONITORING_DATA
          type: string
        fieldName:
          description: Name of the entity field to filter policies by.
          maxLength: 50
          nullable: true
          type: string
        fieldValue:
          description: Value of the entity field to filter policies by.
          maxLength: 50
          nullable: true
          type: string
        policyId:
          description: ID of the matching approval policy. ``null`` if no matching
            policies found.
          nullable: true
          type: string
      required:
      - action
      - entityType
      - policyId
      type: object
    ApprovalPolicyResponse:
      properties:
        active:
          default: true
          description: Whether this policy is active.
          type: boolean
        automaticAction:
          $ref: '#/components/schemas/ApprovalPolicyAutomaticAction'
          description: An object describing the automated action on the Change Request
            that will be performed if the request is not resolved within a given time
            period after its creation. If ``null``, no automated actions will be taken
            on the related Change Requests.
          nullable: true
        id:
          description: ID of the Approval Policy.
          type: string
        name:
          description: Name of the Approval Policy.
          maxLength: 50
          type: string
        openRequests:
          description: Number of open Change Requests associated with the policy.
          minimum: 0
          type: integer
        review:
          $ref: '#/components/schemas/ApprovalPolicyReview'
          description: An object describing review requirements for Change Requests,
            related to a specific policy. If ``null``, no additional review requirements
            are added to the related Change Requests.
          nullable: true
        trigger:
          $ref: '#/components/schemas/ApprovalPolicyTrigger'
          description: An object describing the trigger for the Approval Policy.
      required:
      - active
      - id
      - name
      - openRequests
      - trigger
      type: object
    ApprovalPolicyReview:
      properties:
        groups:
          description: A list of user groups that will be added as required reviewers
            on Change Requests for the entities that match the policy.
          items:
            $ref: '#/components/schemas/PolicyUserGroup'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
        reminderPeriod:
          description: Duration period in ISO 8601 format that indicates when to send
            a reminder for reviewing a Change Request after its creation or last reminder
            if it hasn't been approved yet. If ``null``, no review reminders are sent
            to the reviewers.
          format: duration
          nullable: true
          type: string
      type: object
    ApprovalPolicyTrigger:
      properties:
        entityType:
          description: Type of entity to trigger on.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - deploymentModel
          - DeploymentModel
          - DEPLOYMENT_MODEL
          - deploymentConfig
          - DeploymentConfig
          - DEPLOYMENT_CONFIG
          - deploymentStatus
          - DeploymentStatus
          - DEPLOYMENT_STATUS
          - deploymentMonitoringData
          - DeploymentMonitoringData
          - DEPLOYMENT_MONITORING_DATA
          type: string
        filterGroups:
          description: A list of user groups to apply Approval Policy for. If User
            'A' and User 'B' are both members of the same organisation, and User 'A'
            is a member of one of the groups listed in this field,but User 'B' is
            not, then an approval workflow will be triggerred for User 'A' on an action
            to the entity that matches policy condition, but not for User 'B'. If
            ``null``, approvals workflow will be triggered for all users.
          items:
            $ref: '#/components/schemas/PolicyUserGroup'
          maxItems: 100
          nullable: true
          type: array
        intendedAction:
          $ref: '#/components/schemas/ApprovalPolicyIntendedAction'
          description: An object, describing the approvals workflow intended action.
        labels:
          $ref: '#/components/schemas/ApprovalPolicyTriggerLabel'
          description: Trigger Labels.
          nullable: true
      required:
      - entityType
      - intendedAction
      type: object
    ApprovalPolicyTriggerLabel:
      properties:
        groupLabel:
          description: Group Label.
          type: string
        label:
          description: Label.
          type: string
      required:
      - groupLabel
      - label
      type: object
    ApprovalWorkflowListTriggerResponse:
      properties:
        data:
          description: List of available Approval Policy Triggers.
          items:
            $ref: '#/components/schemas/ApprovalPolicyTrigger'
          type: array
      required:
      - data
      type: object
    ArtifactsForModelWithCustomTasksRetrieveResponse:
      properties:
        data:
          description: An archive (tar.gz) of the artifacts produced and persisted
            by a model.
          format: binary
          type: string
      required:
      - data
      type: object
    AssessmentNewFormat:
      properties:
        enrichmentRate:
          $ref: '#/components/schemas/Warnings'
          description: Warning about the enrichment rate
        enrichmentRateValue:
          description: Percentage of primary table records that can be enriched with
            a record in this dataset
          type: number
        featureDerivationWindow:
          description: Feature derivation window.
          nullable: true
          type: string
        mostRecentData:
          $ref: '#/components/schemas/Warnings'
          description: Warning about the most recent data
        overallCategory:
          description: Class of the relationship quality
          enum:
          - green
          - yellow
          type: string
        windowSettings:
          $ref: '#/components/schemas/Warnings'
          description: Warning about the feature derivation window settings
      required:
      - enrichmentRate
      - enrichmentRateValue
      - overallCategory
      type: object
    AssociationID:
      properties:
        columnNames:
          description: Indicates the columns that will be used to associate actuals
            with predictions.
          items:
            type: string
          nullable: true
          type: array
        requiredInPredictionRequests:
          description: Indicates whether the association ID is required in prediction
            requests.
          type: boolean
      required:
      - columnNames
      - requiredInPredictionRequests
      type: object
    AssociationIDUpdate:
      properties:
        columnNames:
          description: List of column names used to represent an association id. Currently,
            exactly one column name may be provided.
          items:
            type: string
          maxItems: 1
          minItems: 1
          nullable: true
          type: array
        requiredInPredictionRequests:
          description: 'Whether or not association id values are required in each
            prediction request for this deployment. Note that you may not change an
            association ID''s column names after they have been set and predictions
            including those columns have been made '
          type: boolean
      type: object
    AuditLogContextObjectResponse:
      properties:
        orgId:
          description: The id of the organization.
          nullable: true
          type: string
        orgName:
          description: The name of the organization.
          nullable: true
          type: string
        projectName:
          description: The name of the project.
          nullable: true
          type: string
        projectType:
          description: The type of project.
          nullable: true
          type: string
        userProjectRole:
          description: The role of the user associated with this project.
          nullable: true
          type: string
      type: object
    AuditLogsEventListResponse:
      properties:
        count:
          description: Total count of event labels.
          type: integer
        data:
          description: A json array of event labels.
          items:
            description: The name of the event
            type: string
          type: array
      required:
      - count
      - data
      type: object
    AuditLogsRetrieveOneResponse:
      properties:
        context:
          $ref: '#/components/schemas/AuditLogContextObjectResponse'
          description: An object with additional attributes for the record.
        event:
          description: The record event label, e.g. 'Start Autopilot'.
          type: string
        id:
          description: The record ID.
          type: string
        ip:
          description: The IP address of the server where the record event happened.
            Will be empty if ``includeIdentifyingFields`` is True.
          nullable: true
          type: string
        projectId:
          description: The record event project id.
          nullable: true
          type: string
        timestamp:
          description: The record timestamp.
          format: date-time
          type: string
        userId:
          description: The user id of the record events user.
          type: string
        username:
          description: The username of the record events user. Will be empty if ``includeIdentifyingFields``
            is True.
          nullable: true
          type: string
      required:
      - context
      - event
      - id
      - projectId
      - timestamp
      - userId
      type: object
    AuditLogsRetrieveResponse:
      properties:
        count:
          description: The number of returned items.
          type: integer
        data:
          description: A json array of audit log records structured in the same form
            as the response :http:get:`/api/v2/eventLogs/(recordId)/`
          items:
            $ref: '#/components/schemas/AuditLogsRetrieveOneResponse'
          type: array
        next:
          description: A URL to the next page (if null, no next page exists).
          format: uri
          nullable: true
          type: string
        previous:
          description: A URL to the previous page (if null, no previous page exists).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The number of items matching the query condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    AutomatedDocCreate:
      properties:
        documentType:
          description: Type of the automated document you want to generate.
          enum:
          - AUTOPILOT_SUMMARY
          - MODEL_COMPLIANCE
          - DEPLOYMENT_REPORT
          type: string
          x-enum-versionadded:
          - value: DEPLOYMENT_REPORT
            x-versionadded: v2.24
        documentTypeSpecificParameters:
          description: 'Set parameters unique for a specific document type. Currently,
            only these document types can have document-specific parameters: [''DEPLOYMENT_REPORT'']'
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AutomatedDocCreateDeploymentReport'
          - $ref: '#/components/schemas/AutomatedDocCreateModelComplianceDocs'
          x-versionadded: v.2.24
        entityId:
          description: ID of the entity to generate the document for. It can be a
            model ID, a project ID.
          type: string
        locale:
          description: Localization of the document. Defaults to EN_US.
          enum:
          - EN_US
          - JA_JP
          type: string
        outputFormat:
          description: Format to generate the document in.
          enum:
          - docx
          - html
          type: string
        templateId:
          description: Template ID to use for the document outline. Defaults to standard
            Datarobot template.
          type: string
      required:
      - documentType
      - entityId
      - outputFormat
      type: object
    AutomatedDocCreateDeploymentReport:
      properties:
        bucketSize:
          description: You can regulate the size of the buckets in charts. One bucket
            reflects some duration period and you can set the exact duration with
            this parameter. Bucket size gets defaulted to either a month, a week,
            or a day, based on the time range of the report. We use `ISO 8601 <https://www.digi.com/resources/documentation/digidocs/90001437-13/reference/r_iso_8601_duration_format.htm>`_
            duration format to specify values.
          format: duration
          type: string
        end:
          description: 'End of the period to retrieve monitoring data, defaults to
            the next top of the hour. Note: this field only accepts top of the hour
            RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
          format: date-time
          nullable: true
          type: string
        modelId:
          description: Provide a model ID to generate a report for a previously deployed
            model.
          type: string
        start:
          description: 'Start of the period to retrieve monitoring data, defaults
            to 7 days ago from the end of the period. Note: this field only accepts
            top of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
          format: date-time
          nullable: true
          type: string
      type: object
    AutomatedDocCreateModelComplianceDocs:
      type: object
    AutomatedDocItem:
      properties:
        createdAt:
          description: Timestamp for the document creation time.
          format: date-time
          type: string
        docTypeSpecificInfo:
          description: Information that is specific for a certain document type.
          oneOf:
          - $ref: '#/components/schemas/DocTypeSpecificInfoDeploymentReport'
          - $ref: '#/components/schemas/DocTypeSpecificInfoModelCompliance'
        documentType:
          description: Type of the generated document.
          enum:
          - AUTOPILOT_SUMMARY
          - MODEL_COMPLIANCE
          - DEPLOYMENT_REPORT
          type: string
          x-enum-versionadded:
          - value: DEPLOYMENT_REPORT
            x-versionadded: v2.24
        entityId:
          description: Unique identifier of the entity the document was generated
            for.
          type: string
        id:
          description: Unique identifier of the generated document.
          type: string
        locale:
          description: Locale of the generated document.
          enum:
          - EN_US
          - JA_JP
          type: string
        outputFormat:
          description: File format of the generated document.
          enum:
          - docx
          - html
          type: string
        templateId:
          description: Unique identifier of the template used for the document outline.
          type: string
      required:
      - createdAt
      - documentType
      - entityId
      - id
      - outputFormat
      - templateId
      type: object
    AutomatedDocListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of generated documents.
          items:
            $ref: '#/components/schemas/AutomatedDocItem'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    AutomatedDocOptions:
      properties:
        documentType:
          description: Type of document available for generation.
          enum:
          - AUTOPILOT_SUMMARY
          - MODEL_COMPLIANCE
          - DEPLOYMENT_REPORT
          type: string
          x-enum-versionadded:
          - value: DEPLOYMENT_REPORT
            x-versionadded: v2.24
        locale:
          description: Locale available for the document generation.
          enum:
          - EN_US
          - JA_JP
          type: string
      required:
      - documentType
      - locale
      type: object
    AutomatedDocOptionsResponse:
      properties:
        data:
          description: List of document types available for generation.
          items:
            $ref: '#/components/schemas/AutomatedDocOptions'
          type: array
      required:
      - data
      type: object
    AutomatiActuals:
      properties:
        enabled:
          description: Indicates whether automatic actuals is enabled for the deployment.
          type: boolean
      required:
      - enabled
      type: object
    Autopilot:
      properties:
        command:
          description: If `start`, will unpause the autopilot and run queued jobs
            if workers are available.  If `stop`, will pause the autopilot so no new
            jobs will be started.
          enum:
          - start
          - stop
          type: string
      required:
      - command
      type: object
    AutopilotOptions:
      properties:
        blendBestModels:
          description: Blend best models during Autopilot run. This option is not
            supported in SHAP-only mode.
          type: boolean
        mode:
          description: The autopilot mode.
          enum:
          - auto
          - comprehensive
          - quick
          type: string
        runLeakageRemovedFeatureList:
          description: Run Autopilot on Leakage Removed feature list (if exists).
          type: boolean
        scoringCodeOnly:
          description: Keep only models that can be converted to scorable java code
            during Autopilot run.
          type: boolean
        shapOnlyMode:
          description: Include only models with SHAP value support.
          type: boolean
      type: object
    AutopilotStart:
      properties:
        autopilotClusterList:
          description: Optional. A list of integers where each value will be used
            as the number of clusters in Autopilot model(s) for unsupervised clustering
            projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType
            is set to 'clustering'.
          items:
            maximum: 100
            minimum: 2
            type: integer
          maxItems: 10
          nullable: true
          type: array
          x-versionadded: v2.25
        blendBestModels:
          description: Blend best models during Autopilot run. This option is not
            supported in SHAP-only mode or for multilabel projects.
          type: boolean
          x-versionadded: v2.21
        considerBlendersInRecommendation:
          description: Include blenders when selecting a model to prepare for deployment
            in an Autopilot Run. This option is not supported in SHAP-only mode or
            for multilabel projects.
          type: boolean
          x-versionadded: v2.21
        featurelistId:
          description: The ID of a featurelist that should be used for autopilot.
          type: string
        mode:
          default: auto
          description: The autopilot mode.
          enum:
          - auto
          - comprehensive
          - quick
          type: string
        prepareModelForDeployment:
          description: Prepare model for deployment during Autopilot run. The preparation
            includes creating reduced feature list models, retraining best model on
            higher sample size, computing insights and assigning "RECOMMENDED FOR
            DEPLOYMENT" label.
          type: boolean
          x-versionadded: v2.21
        runLeakageRemovedFeatureList:
          description: Run Autopilot on Leakage Removed feature list (if exists).
          type: boolean
          x-versionadded: v2.21
        scoringCodeOnly:
          description: Keep only models that can be converted to scorable java code
            during Autopilot run.
          type: boolean
          x-versionadded: v2.21
        useGpu:
          description: Use GPU workers for Autopilot run.
          type: boolean
          x-versionadded: v2.33
      required:
      - featurelistId
      type: object
    AverageModelMetricsField:
      properties:
        metrics:
          description: Average model metrics for the given thresholds.
          items:
            $ref: '#/components/schemas/AverageModelMetricsValues'
          maxItems: 8
          minItems: 8
          type: array
        source:
          description: Chart source.
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
        thresholds:
          description: Threshold values for which model metrics are available.
          items:
            maximum: 1.0
            minimum: 0.0
            type: number
          maxItems: 100
          minItems: 100
          type: array
      required:
      - metrics
      - source
      - thresholds
      type: object
    AverageModelMetricsValues:
      properties:
        name:
          description: Metric name.
          enum:
          - accuracy
          - f1Score
          - falsePositiveRate
          - matthewsCorrelationCoefficient
          - negativePredictiveValue
          - positivePredictiveValue
          - trueNegativeRate
          - truePositiveRate
          type: string
        numLabelsUsedInCalculation:
          description: Number of labels that were taken into account in the calculation
            of metric averages
          type: integer
        values:
          description: Metric values at given thresholds.
          items:
            type: number
          maxItems: 100
          minItems: 100
          type: array
      required:
      - name
      - numLabelsUsedInCalculation
      - values
      type: object
    AzureDataStreamer:
      properties:
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: Use the specified credential to access the url
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        type:
          description: Type name for this intake type
          enum:
          - azure
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    AzureIntake:
      properties:
        credentialId:
          description: Use the specified credential to access the url
          nullable: true
          type: string
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        type:
          description: Type name for this intake type
          enum:
          - azure
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    AzureOutput:
      properties:
        credentialId:
          description: Use the specified credential to access the url
          nullable: true
          type: string
        format:
          default: csv
          description: Type of output file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        partitionColumns:
          description: For Parquet directory-scoring only. The column names of the
            intake data of which to partition the dataset. Columns are partitioned
            in the order they are given. At least one value is required if scoring
            to a directory (meaning the output url ends with a slash ("/").
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.26
        type:
          description: Type name for this output type
          enum:
          - azure
          type: string
        url:
          description: URL for the file or directory
          format: url
          type: string
      required:
      - type
      - url
      type: object
    AzureOutputAdaptor:
      properties:
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: Use the specified credential to access the url
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        format:
          default: csv
          description: Type of output file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        partitionColumns:
          description: For Parquet directory-scoring only. The column names of the
            intake data of which to partition the dataset. Columns are partitioned
            in the order they are given. At least one value is required if scoring
            to a directory (meaning the output url ends with a slash ("/").
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.26
        type:
          description: Type name for this output type
          enum:
          - azure
          type: string
        url:
          description: URL for the file or directory
          format: url
          type: string
      required:
      - type
      - url
      type: object
    AzureServicePrincipalCredentials:
      properties:
        azureTenantId:
          description: Tenant ID of the Azure AD service principal.
          type: string
        clientId:
          description: Client ID of the Azure AD service principal.
          type: string
        clientSecret:
          description: Client Secret of the Azure AD service principal.
          type: string
        credentialType:
          description: The type of these credentials, 'azure_service_principal' here.
          enum:
          - azure_service_principal
          type: string
      required:
      - azureTenantId
      - clientId
      - clientSecret
      - credentialType
      type: object
    Backtest:
      properties:
        gapDuration:
          description: A duration string representing the duration of the gap between
            the training and the validation data for this backtest.
          format: duration
          type: string
        index:
          description: The index from zero of the backtest specified by this object.
          type: integer
        primaryTrainingEndDate:
          description: A datetime string representing the end date of the primary
            training data for this backtest.
          format: date-time
          type: string
          x-versionadded: v2.19
        primaryTrainingStartDate:
          description: A datetime string representing the start date of the primary
            training data for this backtest.
          format: date-time
          type: string
          x-versionadded: v2.19
        validationDuration:
          description: A duration string representing the duration of the validation
            data for this backtest.
          format: duration
          type: string
        validationEndDate:
          description: A datetime string representing the end date of the validation
            data for this backtest.
          format: date-time
          type: string
          x-versionadded: v2.19
        validationStartDate:
          description: A datetime string representing the start date of the validation
            data for this backtest.
          format: date-time
          type: string
      required:
      - index
      - validationStartDate
      type: object
    BacktestNewMethodForOpenApi:
      properties:
        index:
          description: The index from zero of the backtest.
          type: integer
        primaryTrainingEndDate:
          description: A datetime string representing the end date of the primary
            training data for this backtest.
          format: date-time
          type: string
          x-versionadded: v2.19
        primaryTrainingStartDate:
          description: A datetime string representing the start date of the primary
            training data for this backtest.
          format: date-time
          type: string
          x-versionadded: v2.19
        validationEndDate:
          description: A datetime string representing the end date of the validation
            data for this backtest.
          format: date-time
          type: string
          x-versionadded: v2.19
        validationStartDate:
          description: A datetime string representing the start date of the validation
            data for this backtest.
          format: date-time
          type: string
      required:
      - index
      - primaryTrainingEndDate
      - primaryTrainingStartDate
      - validationEndDate
      - validationStartDate
      type: object
    BacktestOldMethodForOpenApi:
      properties:
        gapDuration:
          description: A duration string representing the duration of the gap between
            the training and the validation data for this backtest.
          format: duration
          type: string
        index:
          description: The index from zero of the backtest.
          type: integer
        validationDuration:
          description: A duration string representing the duration of the validation
            data for this backtest.
          format: duration
          type: string
        validationStartDate:
          description: A datetime string representing the start date of the validation
            data for this backtest.
          format: date-time
          type: string
      required:
      - gapDuration
      - index
      - validationDuration
      - validationStartDate
      type: object
    BacktestResponse:
      properties:
        availableTrainingDuration:
          description: The duration of the available training data for this backtest.
          format: duration
          type: string
        availableTrainingEndDate:
          description: The end date of the available training data for this backtest.
          format: date-time
          type: string
        availableTrainingStartDate:
          description: The start date of the available training data for this backtest.
          format: date-time
          type: string
        gapDuration:
          description: The duration of the gap between the training and the validation
            scoring data for this backtest.
          format: duration
          type: string
        gapEndDate:
          description: The end date of the gap between the training and validation
            scoring data for this backtest.
          format: date-time
          type: string
        gapStartDate:
          description: The start date of the gap between the training and validation
            scoring data for this backtest.
          format: date-time
          type: string
        index:
          description: The index from zero of this backtest.
          type: integer
        primaryTrainingDuration:
          description: The duration of the primary training data for this backtest.
          format: duration
          type: string
        primaryTrainingEndDate:
          description: The end date of the primary training data for this backtest.
          format: date-time
          type: string
        primaryTrainingStartDate:
          description: The start date of the primary training data for this backtest.
          format: date-time
          type: string
        validationDuration:
          description: The duration of the validation scoring data for this backtest.
          type: string
        validationEndDate:
          description: The end date of the validation scoring data for this backtest.
          format: date-time
          type: string
        validationStartDate:
          description: The start date of the validation scoring data for this backtest.
          format: date-time
          type: string
      required:
      - availableTrainingDuration
      - availableTrainingEndDate
      - availableTrainingStartDate
      - gapDuration
      - gapEndDate
      - gapStartDate
      - index
      - primaryTrainingDuration
      - primaryTrainingEndDate
      - primaryTrainingStartDate
      - validationDuration
      - validationEndDate
      - validationStartDate
      type: object
    BacktestStabilityPlotData:
      properties:
        backtestIndex:
          description: An integer representing the index of the backtest, starting
            from 0. For holdout, this field will be null.
          minimum: 0
          nullable: true
          type: integer
        partition:
          description: Identifier of the partition. Can either identify a specific
            backtest ("backtest0", "backtest1", ...) or the holdout set ("holdout").
          type: string
        score:
          description: Score for this partition. Can be null if the score is unavailable
            for this partition (e.g. holdout is locked or backtesting has not been
            run yet).
          nullable: true
          type: number
        scoringEndDate:
          description: End date of the subset used for scoring.
          format: date-time
          type: string
        scoringStartDate:
          description: Start date of the subset used for scoring.
          format: date-time
          type: string
      required:
      - backtestIndex
      - partition
      - score
      - scoringEndDate
      - scoringStartDate
      type: object
    BacktestStabilityPlotResponse:
      properties:
        backtestPlotData:
          description: An array of objects containing the details of the scores for
            each partition defined for the project.
          items:
            $ref: '#/components/schemas/BacktestStabilityPlotData'
          type: array
        endDate:
          description: End date of the project dataset.
          format: date-time
          type: string
        metricName:
          description: Name of the metric used to compute the scores.
          type: string
        startDate:
          description: Start date of the project dataset.
          format: date-time
          type: string
      required:
      - backtestPlotData
      - endDate
      - metricName
      - startDate
      type: object
    BacktestStatusResponse:
      properties:
        index:
          description: the index of the fold
          type: integer
        score:
          description: the score of the model for this backtesting fold, if computed
          nullable: true
          type: number
        status:
          description: the status of the current backtest model job
          enum:
          - COMPLETED
          - NOT_COMPLETED
          - INSUFFICIENT_DATA
          - ERRORED
          - BACKTEST_BOUNDARIES_EXCEEDED
          type: string
        trainingDuration:
          description: the duration of the data used to train the model for this backtesting
            fold
          format: duration
          type: string
        trainingEndDate:
          description: the end date of the training for this backtesting fold
          format: date-time
          type: string
        trainingRowCount:
          description: the number of rows used to train the model for this backtesting
            fold
          type: integer
        trainingStartDate:
          description: the start date of the training for this backtesting fold
          format: date-time
          type: string
      required:
      - index
      - score
      - status
      - trainingDuration
      - trainingEndDate
      - trainingRowCount
      - trainingStartDate
      type: object
    Backtests:
      properties:
        validationEndDate:
          description: The end date of the validation scoring data for this backtest.
          format: date-time
          type: string
        validationStartDate:
          description: The start date of the validation scoring data for this backtest.
          format: date-time
          type: string
      required:
      - validationEndDate
      - validationStartDate
      type: object
    BaseConstraintType:
      properties:
        supportsGridSearch:
          description: When True, Grid Search is supported for this parameter.
          type: boolean
      required:
      - supportsGridSearch
      type: object
    BaseDependencyBuildMetadataResponse:
      properties:
        buildEnd:
          description: The ISO-8601 encoded time when this build completed.
          nullable: true
          type: string
        buildLogLocation:
          description: The URL to download the build logs from this build.
          format: uri
          nullable: true
          type: string
        buildStart:
          description: The ISO-8601 encoded time when this build started.
          type: string
        buildStatus:
          description: The current status of the dependency build.
          enum:
          - submitted
          - processing
          - failed
          - success
          type: string
      required:
      - buildEnd
      - buildLogLocation
      - buildStart
      - buildStatus
      type: object
    BaseLagsArguments:
      properties:
        orders:
          description: Lag orders.
          items:
            exclusiveMinimum: true
            minimum: 0
            type: integer
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - orders
      type: object
    BaseNumericStatsArguments:
      properties:
        methods:
          description: Methods to apply in a rolling window.
          items:
            enum:
            - avg
            - max
            - median
            - min
            - stddev
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
        windowSize:
          description: Rolling window size, defined in terms of rows. Left end is
            exclusive, right end is inclusive.
          exclusiveMinimum: true
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - methods
      - windowSize
      type: object
    BasicCredentials:
      properties:
        credentialType:
          description: The type of these credentials, 'basic' here.
          enum:
          - basic
          type: string
        password:
          description: The password for database authentication. The password is encrypted
            at rest and never saved / stored.
          type: string
        user:
          description: The username for database authentication.
          type: string
      required:
      - credentialType
      - password
      - user
      type: object
    BasicDatasetDetailsResponse:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          items:
            description: The dataset category.
            enum:
            - BATCH_PREDICTIONS
            - CUSTOM_MODEL_TESTING
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          type: array
        createdBy:
          description: Username of the user who created the dataset.
          nullable: true
          type: string
        creationDate:
          description: The date when the dataset was created.
          format: date-time
          type: string
        dataPersisted:
          description: If true, user is allowed to view extended data profile (which
            includes data statistics like min/max/median/mean, histogram, etc.) and
            download data. If false, download is not allowed and only the data schema
            (feature names and types) will be available.
          type: boolean
        datasetId:
          description: The ID of this dataset.
          type: string
        isDataEngineEligible:
          description: Whether this dataset can be a data source of a data engine
            query.
          type: boolean
          x-versionadded: v2.20
        isLatestVersion:
          description: Whether this dataset version is the latest version of this
            dataset.
          type: boolean
        isSnapshot:
          description: Whether the dataset is an immutable snapshot of data which
            has previously been retrieved and saved to DataRobot.
          type: boolean
        name:
          description: The name of this dataset in the catalog.
          type: string
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
          x-versionadded: v2.21
        sampleSize:
          $ref: '#/components/schemas/SampleSize'
          description: Ingest size to use during dataset registration. Default behavior
            is to ingest full dataset.
          nullable: true
          x-versionadded: v2.27
        timeSeriesProperties:
          $ref: '#/components/schemas/TimeSeriesProperties'
          description: Properties related to time series data prep.
          x-versionadded: v2.26
        versionId:
          description: The object ID of the catalog_version the dataset belongs to.
          type: string
      required:
      - categories
      - createdBy
      - creationDate
      - dataPersisted
      - datasetId
      - isDataEngineEligible
      - isLatestVersion
      - isSnapshot
      - name
      - processingState
      - timeSeriesProperties
      - versionId
      type: object
    BasicDatasetWithSizeResponse:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          items:
            description: The dataset category.
            enum:
            - BATCH_PREDICTIONS
            - CUSTOM_MODEL_TESTING
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          type: array
        columnCount:
          description: The number of columns in the dataset.
          type: integer
          x-versionadded: v2.30
        createdBy:
          description: Username of the user who created the dataset.
          nullable: true
          type: string
        creationDate:
          description: The date when the dataset was created.
          format: date-time
          type: string
        dataPersisted:
          description: If true, user is allowed to view extended data profile (which
            includes data statistics like min/max/median/mean, histogram, etc.) and
            download data. If false, download is not allowed and only the data schema
            (feature names and types) will be available.
          type: boolean
        datasetId:
          description: The ID of this dataset.
          type: string
        datasetSize:
          description: The size of the dataset as a CSV in bytes.
          type: integer
          x-versionadded: v2.21
        isDataEngineEligible:
          description: Whether this dataset can be a data source of a data engine
            query.
          type: boolean
          x-versionadded: v2.20
        isLatestVersion:
          description: Whether this dataset version is the latest version of this
            dataset.
          type: boolean
        isSnapshot:
          description: Whether the dataset is an immutable snapshot of data which
            has previously been retrieved and saved to DataRobot.
          type: boolean
        name:
          description: The name of this dataset in the catalog.
          type: string
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
          x-versionadded: v2.21
        rowCount:
          description: The number of rows in the dataset.
          type: integer
          x-versionadded: v2.21
        sampleSize:
          $ref: '#/components/schemas/SampleSize'
          description: Ingest size to use during dataset registration. Default behavior
            is to ingest full dataset.
          nullable: true
          x-versionadded: v2.27
        timeSeriesProperties:
          $ref: '#/components/schemas/TimeSeriesProperties'
          description: Properties related to time series data prep.
          x-versionadded: v2.26
        versionId:
          description: The object ID of the catalog_version the dataset belongs to.
          type: string
      required:
      - categories
      - columnCount
      - createdBy
      - creationDate
      - dataPersisted
      - datasetId
      - datasetSize
      - isDataEngineEligible
      - isLatestVersion
      - isSnapshot
      - name
      - processingState
      - rowCount
      - timeSeriesProperties
      - versionId
      type: object
    Batch:
      properties:
        earliestPredictionTimestamp:
          description: Earliest prediction timestamp of a batch.
          format: date-time
          type: string
          x-versionadded: v2.33
        id:
          description: Batch ID.
          type: string
          x-versionadded: v2.33
        latestPredictionTimestamp:
          description: Latest prediction timestamp of a batch.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: Batch name.
          type: string
          x-versionadded: v2.33
      required:
      - earliestPredictionTimestamp
      - id
      - latestPredictionTimestamp
      - name
      type: object
    BatchFeatureTransform:
      properties:
        parentNames:
          description: List of feature names that will be transformed into a new variable
            type.
          items:
            type: string
          maxItems: 500
          minItems: 1
          type: array
        prefix:
          description: The string that will preface all feature names. Optional if
            suffix is present. (One or both are required.)
          maxLength: 500
          type: string
        suffix:
          description: The string that will be appended at the end to all feature
            names. Optional if prefix is present. (One or both are required.)
          maxLength: 500
          type: string
        variableType:
          description: The type of the new feature. Must be one of `text`, `categorical`
            (Deprecated in version v2.21), `numeric`, or `categoricalInt`.
          enum:
          - text
          - categorical
          - numeric
          - categoricalInt
          type: string
      required:
      - parentNames
      - variableType
      type: object
    BatchFeatureTransformRetrieveResponse:
      properties:
        failures:
          description: An object keyed by original feature names, the values are strings
            indicating why the transformation failed.
          type: object
        newFeatureNames:
          description: List of new feature names.
          items:
            type: string
          type: array
      required:
      - failures
      - newFeatureNames
      type: object
    BatchField:
      properties:
        columnName:
          description: Column name
          nullable: true
          type: string
      required:
      - columnName
      type: object
    BatchJobCSVSettings:
      properties:
        delimiter:
          default: ','
          description: CSV fields are delimited by this character. Use the string
            "tab" to denote TSV (TAB separated values).
          oneOf:
          - enum:
            - tab
            type: string
          - maxLength: 1
            minLength: 1
            type: string
        encoding:
          default: utf-8
          description: 'The encoding to be used for intake and output. For example
            (but not limited to): "shift_jis", "latin_1" or "mskanji".'
          type: string
        quotechar:
          default: '"'
          description: Fields containing the delimiter or newlines must be quoted
            using this character.
          maxLength: 1
          minLength: 1
          type: string
      required:
      - delimiter
      - encoding
      - quotechar
      type: object
    BatchJobCreatedBy:
      properties:
        fullName:
          description: The full name of the user who created this job (if defined
            by the user)
          nullable: true
          type: string
        userId:
          description: The User ID of the user who created this job
          type: string
        username:
          description: The username (e-mail address) of the user who created this
            job
          type: string
      required:
      - fullName
      - userId
      - username
      type: object
    BatchJobPredictionInstance:
      properties:
        apiKey:
          description: By default, prediction requests will use the API key of the
            user that created the job. This allows you to make requests on behalf
            of other users.
          type: string
        datarobotKey:
          description: If running a job against a prediction instance in the Managed
            AI Cloud, you must provide the organization level DataRobot-Key.
          type: string
        hostName:
          description: Override the default host name of the deployment with this.
          type: string
        sslEnabled:
          default: true
          description: Use SSL (HTTPS) when communicating with the overriden prediction
            server.
          type: boolean
      required:
      - hostName
      - sslEnabled
      type: object
    BatchJobRemapping:
      properties:
        inputName:
          description: Rename column with this name
          type: string
        outputName:
          description: Rename column to this name (leave as null to remove from the
            output)
          nullable: true
          type: string
      required:
      - inputName
      - outputName
      type: object
    BatchJobTimeSeriesSettingsForecast:
      properties:
        forecastPoint:
          description: Used for forecast predictions in order to override the inferred
            forecast point from the dataset.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          default: false
          description: If activated, missing values in the known in advance features
            are allowed in the forecast window at prediction time. If omitted or false,
            missing values are not allowed.
          type: boolean
        type:
          description: Forecast mode makes predictions using forecastPoint or rows
            in the dataset without target.
          enum:
          - forecast
          type: string
      required:
      - type
      type: object
    BatchJobTimeSeriesSettingsHistorical:
      properties:
        predictionsEndDate:
          description: Used for historical predictions in order to override date to
            which predictions should be calculated. By default value will be inferred
            automatically from the dataset.
          format: date-time
          type: string
        predictionsStartDate:
          description: Used for historical predictions in order to override date from
            which predictions should be calculated. By default value will be inferred
            automatically from the dataset.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          default: false
          description: If activated, missing values in the known in advance features
            are allowed in the forecast window at prediction time. If omitted or false,
            missing values are not allowed.
          type: boolean
        type:
          description: Historical mode enables bulk predictions which calculates predictions
            for all possible forecast points and forecast distances in the dataset
            within the predictionsStartDate/predictionsEndDate range.
          enum:
          - historical
          type: string
      required:
      - type
      type: object
    BatchPeriod:
      properties:
        end:
          description: End time of the bucket
          format: date-time
          nullable: true
          type: string
        start:
          description: Start time of the bucket
          format: date-time
          nullable: true
          type: string
      required:
      - end
      - start
      type: object
    BatchPredictionCreatedBy:
      properties:
        fullName:
          description: The full name of the user who created this job (if defined
            by the user)
          nullable: true
          type: string
        userId:
          description: The User ID of the user who created this job
          type: string
        username:
          description: The username (e-mail address) of the user who created this
            job
          type: string
      required:
      - fullName
      - userId
      - username
      type: object
    BatchPredictionJobCSVSettings:
      properties:
        delimiter:
          default: ','
          description: CSV fields are delimited by this character. Use the string
            "tab" to denote TSV (TAB separated values).
          oneOf:
          - enum:
            - tab
            type: string
          - maxLength: 1
            minLength: 1
            type: string
        encoding:
          default: utf-8
          description: 'The encoding to be used for intake and output. For example
            (but not limited to): "shift_jis", "latin_1" or "mskanji".'
          type: string
        quotechar:
          default: '"'
          description: Fields containing the delimiter or newlines must be quoted
            using this character.
          maxLength: 1
          minLength: 1
          type: string
      required:
      - delimiter
      - encoding
      - quotechar
      type: object
    BatchPredictionJobCreate:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        chunkSize:
          default: auto
          description: Which strategy should be used to determine the chunk size.
            Can be either a named strategy or a fixed size in bytes.
          oneOf:
          - enum:
            - auto
            - fixed
            - dynamic
            type: string
          - maximum: 41943040
            minimum: 20
            type: integer
        columnNamesRemapping:
          description: Remap (rename or remove columns from) the output from this
            job
          nullable: true
          oneOf:
          - description: Provide a dictionary with key/value pairs to remap (deprecated)
            type: object
          - description: Provide a list of items to remap
            items:
              $ref: '#/components/schemas/BatchPredictionJobRemapping'
            maxItems: 1000
            type: array
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
          description: The CSV settings used for this job
        deploymentId:
          description: ID of deployment which is used in job for processing predictions
            dataset
          type: string
        disableRowLevelErrorHandling:
          default: false
          description: Skip row by row error handling
          type: boolean
        explanationAlgorithm:
          description: Which algorithm will be used to calculate prediction explanations
          enum:
          - shap
          - xemp
          type: string
        explanationClassNames:
          description: List of class names that will be explained for each row for
            multiclass. Mutually exclusive with explanationNumTopClasses. If neither
            specified - we assume explanationNumTopClasses=1
          items:
            description: Class name to explain
            type: string
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Number of top predicted classes for each row that will be explained
            for multiclass. Mutually exclusive with explanationClassNames. If neither
            specified - we assume explanationNumTopClasses=1
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.29
        includePredictionStatus:
          default: false
          description: Include prediction status column in the output
          type: boolean
        includeProbabilities:
          default: true
          description: Include probabilities for all classes
          type: boolean
        includeProbabilitiesClasses:
          default: []
          description: Include only probabilities for these specific class names.
          items:
            description: Include probability for this class name
            type: string
          maxItems: 100
          type: array
        intakeSettings:
          default:
            type: localFile
          description: The intake option configured for this job
          oneOf:
          - $ref: '#/components/schemas/AzureIntake'
            description: Stream CSV data chunks from Azure
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            description: Stream CSV data chunks from Big Query using GCS
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            description: Stream CSV data chunks from data stage storage
            x-versionadded: v2.28
          - $ref: '#/components/schemas/Catalog'
            description: Stream CSV data chunks from AI catalog dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DSS'
            description: Stream CSV data chunks from DSS dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            description: Stream CSV data chunks from Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            description: Stream CSV data chunks from HTTP
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            description: Stream CSV data chunks from JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            description: Stream CSV data chunks from local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            description: Stream CSV data chunks from Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            description: Stream CSV data chunks from Snowflake
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            description: Stream CSV data chunks from Azure Synapse
            x-versionadded: v2.25
        maxExplanations:
          default: 0
          description: Number of explanations requested. Will be ordered by strength.
          maximum: 100
          minimum: 0
          type: integer
        modelId:
          description: ID of leaderboard model which is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        modelPackageId:
          description: ID of model package from registry is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          nullable: true
          type: string
        numConcurrent:
          description: Number of simultaneous requests to run against the prediction
            instance
          minimum: 1
          type: integer
        outputSettings:
          description: The output option configured for this job
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            description: Save CSV data chunks to Azure Blob Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            description: Save CSV data chunks to Google BigQuery in bulk
            x-versionadded: v2.26
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            description: Save CSV data chunks to Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            description: Save CSV data chunks to HTTP data endpoint
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            description: Save CSV data chunks via JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            description: Save CSV data chunks to local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            description: Saves CSV data chunks to Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            description: Save CSV data chunks to Snowflake in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            description: Save CSV data chunks to Azure Synapse in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/Tableau'
            description: Save CSV data chunks to local file storage as .hyper file
            x-versionadded: v2.21
        passthroughColumns:
          description: Pass through columns from the original dataset
          items:
            description: A column name from the original dataset to pass through to
              the resulting predictions
            maxLength: 50
            minLength: 1
            type: string
          maxItems: 100
          type: array
        passthroughColumnsSet:
          description: Pass through all columns from the original dataset
          enum:
          - all
          type: string
        pinnedModelId:
          description: Specify a model ID used for scoring
          type: string
        predictionInstance:
          $ref: '#/components/schemas/BatchPredictionJobPredictionInstance'
          description: Override the default prediction instance from the deployment
            when scoring this job.
          nullable: true
        predictionThreshold:
          description: Threshold is the point that sets the class boundary for a predicted
            value. The model classifies an observation below the threshold as FALSE,
            and an observation above the threshold as TRUE. In other words, DataRobot
            automatically assigns the positive class label to any prediction exceeding
            the threshold. This value can be set between 0.0 and 1.0.
          maximum: 1.0
          minimum: 0.0
          type: number
        predictionWarningEnabled:
          description: Enable prediction warnings.
          nullable: true
          type: boolean
        secondaryDatasetsConfigId:
          description: Configuration id for secondary datasets to use when making
            a prediction.
          type: string
          x-versionadded: v2.33
        skipDriftTracking:
          default: false
          description: Skip drift tracking for this job.
          type: boolean
        thresholdHigh:
          description: Compute explanations for predictions above this threshold
          type: number
        thresholdLow:
          description: Compute explanations for predictions below this threshold
          type: number
        timeseriesSettings:
          description: Time Series settings included of this job is a Time Series
            job.
          oneOf:
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsForecast'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsHistorical'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsTraining'
          x-versionadded: v2.20
      required:
      - abortOnError
      - csvSettings
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - skipDriftTracking
      type: object
    BatchPredictionJobDefinitionId:
      properties:
        jobDefinitionId:
          description: ID of the Batch Prediction job definition
          type: string
      required:
      - jobDefinitionId
      type: object
    BatchPredictionJobDefinitionJobSpecResponse:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        batchJobType:
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
          x-versionadded: v2.30
        chunkSize:
          default: auto
          description: Which strategy should be used to determine the chunk size.
            Can be either a named strategy or a fixed size in bytes.
          oneOf:
          - enum:
            - auto
            - fixed
            - dynamic
            type: string
          - maximum: 41943040
            minimum: 20
            type: integer
        columnNamesRemapping:
          description: Remap (rename or remove columns from) the output from this
            job
          nullable: true
          oneOf:
          - description: Provide a dictionary with key/value pairs to remap (deprecated)
            type: object
          - description: Provide a list of items to remap
            items:
              $ref: '#/components/schemas/BatchJobRemapping'
            maxItems: 1000
            type: array
        csvSettings:
          $ref: '#/components/schemas/BatchJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
          description: The CSV settings used for this job
        deploymentId:
          description: ID of deployment which is used in job for processing predictions
            dataset
          type: string
        disableRowLevelErrorHandling:
          default: false
          description: Skip row by row error handling
          type: boolean
        explanationAlgorithm:
          description: Which algorithm will be used to calculate prediction explanations
          enum:
          - shap
          - xemp
          type: string
        explanationClassNames:
          description: List of class names that will be explained for each row for
            multiclass. Mutually exclusive with explanationNumTopClasses. If neither
            specified - we assume explanationNumTopClasses=1
          items:
            description: Class name to explain
            type: string
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.30
        explanationNumTopClasses:
          description: Number of top predicted classes for each row that will be explained
            for multiclass. Mutually exclusive with explanationClassNames. If neither
            specified - we assume explanationNumTopClasses=1
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.30
        includePredictionStatus:
          default: false
          description: Include prediction status column in the output
          type: boolean
        includeProbabilities:
          default: true
          description: Include probabilities for all classes
          type: boolean
        includeProbabilitiesClasses:
          default: []
          description: Include only probabilities for these specific class names.
          items:
            description: Include probability for this class name
            type: string
          maxItems: 100
          type: array
        intakeSettings:
          default:
            type: localFile
          description: The response option configured for this job
          oneOf:
          - $ref: '#/components/schemas/AzureDataStreamer'
            description: Stream CSV data chunks from Azure
            x-versionadded: v2.21
          - $ref: '#/components/schemas/DataStageDataStreamer'
            description: Stream CSV data chunks from data stage storage
            x-versionadded: v2.28
          - $ref: '#/components/schemas/CatalogDataStreamer'
            description: Stream CSV data chunks from AI catalog dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/GCPDataStreamer'
            description: Stream CSV data chunks from Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryDataStreamer'
            description: Stream CSV data chunks from Big Query using GCS
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3DataStreamer'
            description: Stream CSV data chunks from Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeDataStreamer'
            description: Stream CSV data chunks from Snowflake
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseDataStreamer'
            description: Stream CSV data chunks from Azure Synapse
            x-versionadded: v2.25
          - $ref: '#/components/schemas/DSSDataStreamer'
            description: Stream CSV data chunks from DSS dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HTTPDataStreamer'
            description: Stream CSV data chunks from HTTP
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCDataStreamer'
            description: Stream CSV data chunks from JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileDataStreamer'
            description: Stream CSV data chunks from local file storage
            x-versionadded: v2.19
        maxExplanations:
          default: 0
          description: Number of explanations requested. Will be ordered by strength.
          maximum: 100
          minimum: 0
          type: integer
        maxNgramExplanations:
          description: The maximum number of text ngram explanations to supply per
            row of the dataset. The default recommended `maxNgramExplanations` is
            `all` (no limit)
          nullable: true
          oneOf:
          - minimum: 0
            type: integer
          - enum:
            - all
            type: string
          x-versionadded: v2.30
        modelId:
          description: ID of leaderboard model which is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.30
        modelPackageId:
          description: ID of model package from registry is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.30
        monitoringAggregation:
          $ref: '#/components/schemas/MonitoringAggregation'
          description: Defines the aggregation policy for monitoring jobs.
          x-versionadded: v2.30
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          nullable: true
          type: string
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
          description: Column names mapping for monitoring
          x-versionadded: v2.30
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
          description: Output settings for monitoring jobs
        numConcurrent:
          description: Number of simultaneous requests to run against the prediction
            instance
          minimum: 0
          type: integer
        outputSettings:
          description: The response option configured for this job
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AzureOutputAdaptor'
            description: Save CSV data chunks to Azure Blob Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/GCPOutputAdaptor'
            description: Save CSV data chunks to Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutputAdaptor'
            description: Save CSV data chunks to Google BigQuery in bulk
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3OutputAdaptor'
            description: Saves CSV data chunks to Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutputAdaptor'
            description: Save CSV data chunks to Snowflake in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutputAdaptor'
            description: Save CSV data chunks to Azure Synapse in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/FileSystemOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HttpOutputAdaptor'
            description: Save CSV data chunks to HTTP data endpoint
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JdbcOutputAdaptor'
            description: Save CSV data chunks via JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutputAdaptor'
            description: Save CSV data chunks to local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/TableauOutputAdaptor'
            description: Save CSV data chunks to local file storage as .hyper file
            x-versionadded: v2.21
        passthroughColumns:
          description: Pass through columns from the original dataset
          items:
            description: A column name from the original dataset to pass through to
              the resulting predictions
            maxLength: 50
            minLength: 1
            type: string
          maxItems: 100
          type: array
        passthroughColumnsSet:
          description: Pass through all columns from the original dataset
          enum:
          - all
          type: string
        pinnedModelId:
          description: Specify a model ID used for scoring
          type: string
        predictionInstance:
          $ref: '#/components/schemas/BatchJobPredictionInstance'
          description: Override the default prediction instance from the deployment
            when scoring this job.
          nullable: true
        predictionWarningEnabled:
          description: Enable prediction warnings.
          nullable: true
          type: boolean
        redactedFields:
          description: 'A list of qualified field names from intake- and/or outputSettings
            that was redacted due to permissions and sharing settings. For example:
            intakeSettings.dataStoreId'
          items:
            description: Field names that are potentially redacted
            type: string
          type: array
          x-versionadded: v2.30
        skipDriftTracking:
          default: false
          description: Skip drift tracking for this job.
          type: boolean
        thresholdHigh:
          description: Compute explanations for predictions above this threshold
          type: number
        thresholdLow:
          description: Compute explanations for predictions below this threshold
          type: number
        timeseriesSettings:
          description: Time Series settings included of this job is a Time Series
            job.
          oneOf:
          - $ref: '#/components/schemas/BatchJobTimeSeriesSettingsForecast'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsForecastWithPolicy'
          - $ref: '#/components/schemas/BatchJobTimeSeriesSettingsHistorical'
          x-versionadded: v2.20
      required:
      - abortOnError
      - csvSettings
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - numConcurrent
      - redactedFields
      - skipDriftTracking
      type: object
    BatchPredictionJobDefinitionResponse:
      properties:
        createdBy:
          description: The ID of creator of this job definition
          type: string
        id:
          description: The ID of the Batch Prediction job definition
          type: string
        name:
          description: A human-readable name for the definition, must be unique across
            organisations
          type: string
      required:
      - createdBy
      - id
      - name
      type: object
    BatchPredictionJobDefinitionsCreate:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        chunkSize:
          default: auto
          description: Which strategy should be used to determine the chunk size.
            Can be either a named strategy or a fixed size in bytes.
          oneOf:
          - enum:
            - auto
            - fixed
            - dynamic
            type: string
          - maximum: 41943040
            minimum: 20
            type: integer
        columnNamesRemapping:
          description: Remap (rename or remove columns from) the output from this
            job
          nullable: true
          oneOf:
          - description: Provide a dictionary with key/value pairs to remap (deprecated)
            type: object
          - description: Provide a list of items to remap
            items:
              $ref: '#/components/schemas/BatchPredictionJobRemapping'
            maxItems: 1000
            type: array
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
          description: The CSV settings used for this job
        deploymentId:
          description: ID of deployment which is used in job for processing predictions
            dataset
          type: string
        disableRowLevelErrorHandling:
          default: false
          description: Skip row by row error handling
          type: boolean
        enabled:
          description: If this job definition is enabled as a scheduled job. Optional
            if no schedule is supplied.
          type: boolean
        explanationAlgorithm:
          description: Which algorithm will be used to calculate prediction explanations
          enum:
          - shap
          - xemp
          type: string
        explanationClassNames:
          description: List of class names that will be explained for each row for
            multiclass. Mutually exclusive with explanationNumTopClasses. If neither
            specified - we assume explanationNumTopClasses=1
          items:
            description: Class name to explain
            type: string
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Number of top predicted classes for each row that will be explained
            for multiclass. Mutually exclusive with explanationClassNames. If neither
            specified - we assume explanationNumTopClasses=1
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.29
        includePredictionStatus:
          default: false
          description: Include prediction status column in the output
          type: boolean
        includeProbabilities:
          default: true
          description: Include probabilities for all classes
          type: boolean
        includeProbabilitiesClasses:
          default: []
          description: Include only probabilities for these specific class names.
          items:
            description: Include probability for this class name
            type: string
          maxItems: 100
          type: array
        intakeSettings:
          default:
            type: localFile
          description: The intake option configured for this job
          oneOf:
          - $ref: '#/components/schemas/AzureIntake'
            description: Stream CSV data chunks from Azure
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            description: Stream CSV data chunks from Big Query using GCS
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            description: Stream CSV data chunks from data stage storage
            x-versionadded: v2.28
          - $ref: '#/components/schemas/Catalog'
            description: Stream CSV data chunks from AI catalog dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DSS'
            description: Stream CSV data chunks from DSS dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            description: Stream CSV data chunks from Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            description: Stream CSV data chunks from HTTP
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            description: Stream CSV data chunks from JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            description: Stream CSV data chunks from local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            description: Stream CSV data chunks from Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            description: Stream CSV data chunks from Snowflake
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            description: Stream CSV data chunks from Azure Synapse
            x-versionadded: v2.25
        maxExplanations:
          default: 0
          description: Number of explanations requested. Will be ordered by strength.
          maximum: 100
          minimum: 0
          type: integer
        modelId:
          description: ID of leaderboard model which is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        modelPackageId:
          description: ID of model package from registry is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          nullable: true
          type: string
        name:
          description: A human-readable name for the definition, must be unique across
            organisations, if left out the backend will generate one for you.
          maxLength: 100
          minLength: 1
          type: string
        numConcurrent:
          description: Number of simultaneous requests to run against the prediction
            instance
          minimum: 1
          type: integer
        outputSettings:
          description: The output option configured for this job
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            description: Save CSV data chunks to Azure Blob Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            description: Save CSV data chunks to Google BigQuery in bulk
            x-versionadded: v2.26
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            description: Save CSV data chunks to Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            description: Save CSV data chunks to HTTP data endpoint
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            description: Save CSV data chunks via JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            description: Save CSV data chunks to local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            description: Saves CSV data chunks to Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            description: Save CSV data chunks to Snowflake in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            description: Save CSV data chunks to Azure Synapse in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/Tableau'
            description: Save CSV data chunks to local file storage as .hyper file
            x-versionadded: v2.21
        passthroughColumns:
          description: Pass through columns from the original dataset
          items:
            description: A column name from the original dataset to pass through to
              the resulting predictions
            maxLength: 50
            minLength: 1
            type: string
          maxItems: 100
          type: array
        passthroughColumnsSet:
          description: Pass through all columns from the original dataset
          enum:
          - all
          type: string
        pinnedModelId:
          description: Specify a model ID used for scoring
          type: string
        predictionInstance:
          $ref: '#/components/schemas/BatchPredictionJobPredictionInstance'
          description: Override the default prediction instance from the deployment
            when scoring this job.
          nullable: true
        predictionThreshold:
          description: Threshold is the point that sets the class boundary for a predicted
            value. The model classifies an observation below the threshold as FALSE,
            and an observation above the threshold as TRUE. In other words, DataRobot
            automatically assigns the positive class label to any prediction exceeding
            the threshold. This value can be set between 0.0 and 1.0.
          maximum: 1.0
          minimum: 0.0
          type: number
        predictionWarningEnabled:
          description: Enable prediction warnings.
          nullable: true
          type: boolean
        schedule:
          $ref: '#/components/schemas/Schedule'
          description: The scheduling information defining how often and when to execute
            this job to the Job Scheduling service. Optional if enabled = False.
        secondaryDatasetsConfigId:
          description: Configuration id for secondary datasets to use when making
            a prediction.
          type: string
          x-versionadded: v2.33
        skipDriftTracking:
          default: false
          description: Skip drift tracking for this job.
          type: boolean
        thresholdHigh:
          description: Compute explanations for predictions above this threshold
          type: number
        thresholdLow:
          description: Compute explanations for predictions below this threshold
          type: number
        timeseriesSettings:
          description: Time Series settings included of this job is a Time Series
            job.
          oneOf:
          - $ref: '#/components/schemas/BatchJobTimeSeriesSettingsForecast'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsForecastWithPolicy'
          - $ref: '#/components/schemas/BatchJobTimeSeriesSettingsHistorical'
          x-versionadded: v2.20
      required:
      - abortOnError
      - csvSettings
      - deploymentId
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - skipDriftTracking
      type: object
    BatchPredictionJobDefinitionsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of scheduled jobs
          items:
            $ref: '#/components/schemas/BatchPredictionJobDefinitionsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    BatchPredictionJobDefinitionsResponse:
      properties:
        batchPredictionJob:
          $ref: '#/components/schemas/BatchPredictionJobDefinitionJobSpecResponse'
          description: The Batch Prediction Job specification to be put on the queue
            in intervals
        created:
          description: When was this job created
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
          description: Who created this job
        enabled:
          default: false
          description: If this job definition is enabled as a scheduled job.
          type: boolean
        id:
          description: The ID of the Batch job definition
          type: string
        lastFailedRunTime:
          description: Last time this job had a failed run
          format: date-time
          nullable: true
          type: string
        lastScheduledRunTime:
          description: Last time this job was scheduled to run (though not guaranteed
            it actually ran at that time)
          format: date-time
          nullable: true
          type: string
        lastStartedJobStatus:
          description: The status of the latest job launched to the queue (if any).
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          nullable: true
          type: string
        lastStartedJobTime:
          description: The last time (if any) a job was launched.
          format: date-time
          nullable: true
          type: string
        lastSuccessfulRunTime:
          description: Last time this job had a successful run
          format: date-time
          nullable: true
          type: string
        name:
          description: A human-readable name for the definition, must be unique across
            organisations
          type: string
        nextScheduledRunTime:
          description: Next time this job is scheduled to run
          format: date-time
          nullable: true
          type: string
        schedule:
          $ref: '#/components/schemas/Schedule'
          description: The scheduling information defining how often and when to execute
            this job to the Job Scheduling service. Optional if enabled = False.
          nullable: true
        updated:
          description: When was this job last updated
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
          description: Who updated this job last
      required:
      - batchPredictionJob
      - created
      - createdBy
      - enabled
      - id
      - lastStartedJobStatus
      - lastStartedJobTime
      - name
      - updated
      - updatedBy
      type: object
    BatchPredictionJobDefinitionsUpdate:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        chunkSize:
          default: auto
          description: Which strategy should be used to determine the chunk size.
            Can be either a named strategy or a fixed size in bytes.
          oneOf:
          - enum:
            - auto
            - fixed
            - dynamic
            type: string
          - maximum: 41943040
            minimum: 20
            type: integer
        columnNamesRemapping:
          description: Remap (rename or remove columns from) the output from this
            job
          nullable: true
          oneOf:
          - description: Provide a dictionary with key/value pairs to remap (deprecated)
            type: object
          - description: Provide a list of items to remap
            items:
              $ref: '#/components/schemas/BatchPredictionJobRemapping'
            maxItems: 1000
            type: array
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
          description: The CSV settings used for this job
        deploymentId:
          description: ID of deployment which is used in job for processing predictions
            dataset
          type: string
        disableRowLevelErrorHandling:
          default: false
          description: Skip row by row error handling
          type: boolean
        enabled:
          description: If this job definition is enabled as a scheduled job. Optional
            if no schedule is supplied.
          type: boolean
        explanationAlgorithm:
          description: Which algorithm will be used to calculate prediction explanations
          enum:
          - shap
          - xemp
          type: string
        explanationClassNames:
          description: List of class names that will be explained for each row for
            multiclass. Mutually exclusive with explanationNumTopClasses. If neither
            specified - we assume explanationNumTopClasses=1
          items:
            description: Class name to explain
            type: string
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Number of top predicted classes for each row that will be explained
            for multiclass. Mutually exclusive with explanationClassNames. If neither
            specified - we assume explanationNumTopClasses=1
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.29
        includePredictionStatus:
          default: false
          description: Include prediction status column in the output
          type: boolean
        includeProbabilities:
          default: true
          description: Include probabilities for all classes
          type: boolean
        includeProbabilitiesClasses:
          default: []
          description: Include only probabilities for these specific class names.
          items:
            description: Include probability for this class name
            type: string
          maxItems: 100
          type: array
        intakeSettings:
          default:
            type: localFile
          description: The intake option configured for this job
          oneOf:
          - $ref: '#/components/schemas/AzureIntake'
            description: Stream CSV data chunks from Azure
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            description: Stream CSV data chunks from Big Query using GCS
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            description: Stream CSV data chunks from data stage storage
            x-versionadded: v2.28
          - $ref: '#/components/schemas/Catalog'
            description: Stream CSV data chunks from AI catalog dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DSS'
            description: Stream CSV data chunks from DSS dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            description: Stream CSV data chunks from Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            description: Stream CSV data chunks from HTTP
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            description: Stream CSV data chunks from JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            description: Stream CSV data chunks from local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            description: Stream CSV data chunks from Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            description: Stream CSV data chunks from Snowflake
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            description: Stream CSV data chunks from Azure Synapse
            x-versionadded: v2.25
        maxExplanations:
          default: 0
          description: Number of explanations requested. Will be ordered by strength.
          maximum: 100
          minimum: 0
          type: integer
        modelId:
          description: ID of leaderboard model which is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        modelPackageId:
          description: ID of model package from registry is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          nullable: true
          type: string
        name:
          description: A human-readable name for the definition, must be unique across
            organisations, if left out the backend will generate one for you.
          maxLength: 100
          minLength: 1
          type: string
        numConcurrent:
          description: Number of simultaneous requests to run against the prediction
            instance
          minimum: 1
          type: integer
        outputSettings:
          description: The output option configured for this job
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            description: Save CSV data chunks to Azure Blob Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            description: Save CSV data chunks to Google BigQuery in bulk
            x-versionadded: v2.26
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            description: Save CSV data chunks to Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            description: Save CSV data chunks to HTTP data endpoint
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            description: Save CSV data chunks via JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            description: Save CSV data chunks to local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            description: Saves CSV data chunks to Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            description: Save CSV data chunks to Snowflake in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            description: Save CSV data chunks to Azure Synapse in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/Tableau'
            description: Save CSV data chunks to local file storage as .hyper file
            x-versionadded: v2.21
        passthroughColumns:
          description: Pass through columns from the original dataset
          items:
            description: A column name from the original dataset to pass through to
              the resulting predictions
            maxLength: 50
            minLength: 1
            type: string
          maxItems: 100
          type: array
        passthroughColumnsSet:
          description: Pass through all columns from the original dataset
          enum:
          - all
          type: string
        pinnedModelId:
          description: Specify a model ID used for scoring
          type: string
        predictionInstance:
          $ref: '#/components/schemas/BatchPredictionJobPredictionInstance'
          description: Override the default prediction instance from the deployment
            when scoring this job.
          nullable: true
        predictionThreshold:
          description: Threshold is the point that sets the class boundary for a predicted
            value. The model classifies an observation below the threshold as FALSE,
            and an observation above the threshold as TRUE. In other words, DataRobot
            automatically assigns the positive class label to any prediction exceeding
            the threshold. This value can be set between 0.0 and 1.0.
          maximum: 1.0
          minimum: 0.0
          type: number
        predictionWarningEnabled:
          description: Enable prediction warnings.
          nullable: true
          type: boolean
        schedule:
          $ref: '#/components/schemas/Schedule'
          description: The scheduling information defining how often and when to execute
            this job to the Job Scheduling service. Optional if enabled = False.
        secondaryDatasetsConfigId:
          description: Configuration id for secondary datasets to use when making
            a prediction.
          type: string
          x-versionadded: v2.33
        skipDriftTracking:
          default: false
          description: Skip drift tracking for this job.
          type: boolean
        thresholdHigh:
          description: Compute explanations for predictions above this threshold
          type: number
        thresholdLow:
          description: Compute explanations for predictions below this threshold
          type: number
        timeseriesSettings:
          description: Time Series settings included of this job is a Time Series
            job.
          oneOf:
          - $ref: '#/components/schemas/BatchJobTimeSeriesSettingsForecast'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsForecastWithPolicy'
          - $ref: '#/components/schemas/BatchJobTimeSeriesSettingsHistorical'
          x-versionadded: v2.20
      type: object
    BatchPredictionJobId:
      properties:
        partNumber:
          default: 0
          description: 'The number of which csv part is being uploaded when using
            multipart upload '
          minimum: 0
          type: integer
          x-versionadded: v2.27
        predictionJobId:
          description: ID of the Batch Prediction job
          type: string
      required:
      - partNumber
      - predictionJobId
      type: object
    BatchPredictionJobLinks:
      properties:
        csvUpload:
          description: The URL used to upload the dataset for this job. Only available
            for localFile intake.
          format: url
          type: string
        download:
          description: The URL used to download the results from this job. Only available
            for localFile outputs. Will be null if the download is not yet available.
          nullable: true
          type: string
        self:
          description: The URL used access this job.
          format: url
          type: string
      required:
      - self
      type: object
    BatchPredictionJobListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of jobs
          items:
            $ref: '#/components/schemas/BatchPredictionJobResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    BatchPredictionJobPredictionInstance:
      properties:
        apiKey:
          description: By default, prediction requests will use the API key of the
            user that created the job. This allows you to make requests on behalf
            of other users.
          type: string
        datarobotKey:
          description: If running a job against a prediction instance in the Managed
            AI Cloud, you must provide the organization level DataRobot-Key.
          type: string
        hostName:
          description: Override the default host name of the deployment with this.
          type: string
        sslEnabled:
          default: true
          description: Use SSL (HTTPS) when communicating with the overriden prediction
            server.
          type: boolean
      required:
      - hostName
      - sslEnabled
      type: object
    BatchPredictionJobRemapping:
      properties:
        inputName:
          description: Rename column with this name
          type: string
        outputName:
          description: Rename column to this name (leave as null to remove from the
            output)
          nullable: true
          type: string
      required:
      - inputName
      - outputName
      type: object
    BatchPredictionJobResponse:
      properties:
        batchPredictionJobDefinition:
          $ref: '#/components/schemas/BatchPredictionJobDefinitionResponse'
          description: The Batch Prediction Job Definition linking to this job, if
            any.
          nullable: true
          x-versionadded: v2.24
        created:
          description: When was this job created
          format: date-time
          type: string
          x-versionadded: v2.21
        createdBy:
          $ref: '#/components/schemas/BatchPredictionCreatedBy'
          description: Who created this job
          x-versionadded: v2.23
        elapsedTimeSec:
          description: Number of seconds the job has been processing for
          minimum: 0
          type: integer
        failedRows:
          description: Number of rows that have failed scoring
          minimum: 0
          type: integer
        hidden:
          description: When was this job was hidden last, blank if visible
          format: date-time
          type: string
          x-versionadded: v2.24
        id:
          description: The ID of the Batch Prediction job
          type: string
          x-versionadded: v2.21
        intakeDatasetDisplayName:
          description: If applicable (e.g. for AI catalog), will contain the dataset
            name used for the intake dataset.
          nullable: true
          type: string
          x-versionadded: v2.23
        jobIntakeSize:
          description: Number of bytes in the intake dataset for this job
          minimum: 0
          nullable: true
          type: integer
        jobOutputSize:
          description: Number of bytes in the output dataset for this job
          minimum: 0
          nullable: true
          type: integer
        jobSpec:
          $ref: '#/components/schemas/BatchPredictionJobSpecResponse'
          description: The job configuration used to create this job
        links:
          $ref: '#/components/schemas/BatchPredictionJobLinks'
          description: Links useful for this job
        logs:
          description: The job log.
          items:
            description: A log line from the job log.
            type: string
          type: array
        monitoringBatchId:
          description: Id of the monitoring batch created by this job. Only present
            if the job runs on a deployment with batch monitoring enabled.
          nullable: true
          type: string
          x-versionadded: v2.33
        percentageCompleted:
          description: Indicates job progress which is based on number of already
            processed rows in dataset
          maximum: 100
          minimum: 0
          type: number
        queuePosition:
          description: To ensure a dedicated prediction instance is not overloaded,
            only one job will be run against it at a time. This is the number of jobs
            that are awaiting processing before this job start running. May not be
            available in all environments.
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.21
        queued:
          description: The job has been put on the queue for execution.
          type: boolean
          x-versionadded: v2.26
        resultsDeleted:
          description: Indicates if the job was subject to garbage collection and
            had its artifacts deleted (output files, if any, and scoring data on local
            storage)
          type: boolean
          x-versionadded: v2.24
        scoredRows:
          description: Number of rows that have been used in prediction computation
          minimum: 0
          type: integer
        skippedRows:
          description: Number of rows that have been skipped during scoring. May contain
            non-zero value only in time-series predictions case if provided dataset
            contains more than required historical rows.
          minimum: 0
          type: integer
          x-versionadded: v2.20
        source:
          description: Source from which batch job was started
          type: string
          x-versionadded: v2.24
        status:
          description: The current job status
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          type: string
        statusDetails:
          description: Explanation for current status
          type: string
      required:
      - created
      - createdBy
      - elapsedTimeSec
      - failedRows
      - id
      - jobIntakeSize
      - jobOutputSize
      - jobSpec
      - links
      - logs
      - monitoringBatchId
      - percentageCompleted
      - queued
      - scoredRows
      - skippedRows
      - status
      - statusDetails
      type: object
    BatchPredictionJobSpecResponse:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        chunkSize:
          default: auto
          description: Which strategy should be used to determine the chunk size.
            Can be either a named strategy or a fixed size in bytes.
          oneOf:
          - enum:
            - auto
            - fixed
            - dynamic
            type: string
          - maximum: 41943040
            minimum: 20
            type: integer
        columnNamesRemapping:
          description: Remap (rename or remove columns from) the output from this
            job
          nullable: true
          oneOf:
          - description: Provide a dictionary with key/value pairs to remap (deprecated)
            type: object
          - description: Provide a list of items to remap
            items:
              $ref: '#/components/schemas/BatchPredictionJobRemapping'
            maxItems: 1000
            type: array
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
          description: The CSV settings used for this job
        deploymentId:
          description: ID of deployment which is used in job for processing predictions
            dataset
          type: string
        disableRowLevelErrorHandling:
          default: false
          description: Skip row by row error handling
          type: boolean
        explanationAlgorithm:
          description: Which algorithm will be used to calculate prediction explanations
          enum:
          - shap
          - xemp
          type: string
        explanationClassNames:
          description: List of class names that will be explained for each row for
            multiclass. Mutually exclusive with explanationNumTopClasses. If neither
            specified - we assume explanationNumTopClasses=1
          items:
            description: Class name to explain
            type: string
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Number of top predicted classes for each row that will be explained
            for multiclass. Mutually exclusive with explanationClassNames. If neither
            specified - we assume explanationNumTopClasses=1
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.29
        includePredictionStatus:
          default: false
          description: Include prediction status column in the output
          type: boolean
        includeProbabilities:
          default: true
          description: Include probabilities for all classes
          type: boolean
        includeProbabilitiesClasses:
          default: []
          description: Include only probabilities for these specific class names.
          items:
            description: Include probability for this class name
            type: string
          maxItems: 100
          type: array
        intakeSettings:
          default:
            type: localFile
          description: The response option configured for this job
          oneOf:
          - $ref: '#/components/schemas/AzureDataStreamer'
            description: Stream CSV data chunks from Azure
            x-versionadded: v2.21
          - $ref: '#/components/schemas/DataStageDataStreamer'
            description: Stream CSV data chunks from data stage storage
            x-versionadded: v2.28
          - $ref: '#/components/schemas/CatalogDataStreamer'
            description: Stream CSV data chunks from AI catalog dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/GCPDataStreamer'
            description: Stream CSV data chunks from Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryDataStreamer'
            description: Stream CSV data chunks from Big Query using GCS
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3DataStreamer'
            description: Stream CSV data chunks from Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeDataStreamer'
            description: Stream CSV data chunks from Snowflake
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseDataStreamer'
            description: Stream CSV data chunks from Azure Synapse
            x-versionadded: v2.25
          - $ref: '#/components/schemas/DSSDataStreamer'
            description: Stream CSV data chunks from DSS dataset
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HTTPDataStreamer'
            description: Stream CSV data chunks from HTTP
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCDataStreamer'
            description: Stream CSV data chunks from JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileDataStreamer'
            description: Stream CSV data chunks from local file storage
            x-versionadded: v2.19
        maxExplanations:
          default: 0
          description: Number of explanations requested. Will be ordered by strength.
          maximum: 100
          minimum: 0
          type: integer
        modelId:
          description: ID of leaderboard model which is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        modelPackageId:
          description: ID of model package from registry is used in job for processing
            predictions dataset
          type: string
          x-versionadded: v2.28
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          nullable: true
          type: string
        numConcurrent:
          description: Number of simultaneous requests to run against the prediction
            instance
          minimum: 1
          type: integer
        outputSettings:
          description: The response option configured for this job
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AzureOutputAdaptor'
            description: Save CSV data chunks to Azure Blob Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/GCPOutputAdaptor'
            description: Save CSV data chunks to Google Storage
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutputAdaptor'
            description: Save CSV data chunks to Google BigQuery in bulk
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3OutputAdaptor'
            description: Saves CSV data chunks to Amazon Cloud Storage S3
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutputAdaptor'
            description: Save CSV data chunks to Snowflake in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutputAdaptor'
            description: Save CSV data chunks to Azure Synapse in bulk
            x-versionadded: v2.25
          - $ref: '#/components/schemas/FileSystemOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HttpOutputAdaptor'
            description: Save CSV data chunks to HTTP data endpoint
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JdbcOutputAdaptor'
            description: Save CSV data chunks via JDBC
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutputAdaptor'
            description: Save CSV data chunks to local file storage
            x-versionadded: v2.19
          - $ref: '#/components/schemas/TableauOutputAdaptor'
            description: Save CSV data chunks to local file storage as .hyper file
            x-versionadded: v2.21
        passthroughColumns:
          description: Pass through columns from the original dataset
          items:
            description: A column name from the original dataset to pass through to
              the resulting predictions
            maxLength: 50
            minLength: 1
            type: string
          maxItems: 100
          type: array
        passthroughColumnsSet:
          description: Pass through all columns from the original dataset
          enum:
          - all
          type: string
        pinnedModelId:
          description: Specify a model ID used for scoring
          type: string
        predictionInstance:
          $ref: '#/components/schemas/BatchPredictionJobPredictionInstance'
          description: Override the default prediction instance from the deployment
            when scoring this job.
          nullable: true
        predictionThreshold:
          description: Threshold is the point that sets the class boundary for a predicted
            value. The model classifies an observation below the threshold as FALSE,
            and an observation above the threshold as TRUE. In other words, DataRobot
            automatically assigns the positive class label to any prediction exceeding
            the threshold. This value can be set between 0.0 and 1.0.
          maximum: 1.0
          minimum: 0.0
          type: number
        predictionWarningEnabled:
          description: Enable prediction warnings.
          nullable: true
          type: boolean
        redactedFields:
          description: 'A list of qualified field names from intake- and/or outputSettings
            that was redacted due to permissions and sharing settings. For example:
            intakeSettings.dataStoreId'
          items:
            description: Field names that are potentially redacted
            type: string
          type: array
          x-versionadded: v2.30
        secondaryDatasetsConfigId:
          description: Configuration id for secondary datasets to use when making
            a prediction.
          type: string
          x-versionadded: v2.33
        skipDriftTracking:
          default: false
          description: Skip drift tracking for this job.
          type: boolean
        thresholdHigh:
          description: Compute explanations for predictions above this threshold
          type: number
        thresholdLow:
          description: Compute explanations for predictions below this threshold
          type: number
        timeseriesSettings:
          description: Time Series settings included of this job is a Time Series
            job.
          oneOf:
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsForecast'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsHistorical'
          - $ref: '#/components/schemas/BatchPredictionJobTimeSeriesSettingsTraining'
          x-versionadded: v2.20
      required:
      - abortOnError
      - csvSettings
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - redactedFields
      - skipDriftTracking
      type: object
    BatchPredictionJobTimeSeriesSettingsForecast:
      properties:
        forecastPoint:
          description: Used for forecast predictions in order to override the inferred
            forecast point from the dataset.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          default: false
          description: If activated, missing values in the known in advance features
            are allowed in the forecast window at prediction time. If omitted or false,
            missing values are not allowed.
          type: boolean
        type:
          description: Forecast mode makes predictions using forecastPoint or rows
            in the dataset without target.
          enum:
          - forecast
          type: string
      required:
      - type
      type: object
    BatchPredictionJobTimeSeriesSettingsForecastWithPolicy:
      properties:
        forecastPointPolicy:
          $ref: '#/components/schemas/JobRunTimeBasedForecastPointPolicy'
          description: Forecast point policy
          x-versionadded: v2.29
        relaxKnownInAdvanceFeaturesCheck:
          default: false
          description: If activated, missing values in the known in advance features
            are allowed in the forecast window at prediction time. If omitted or false,
            missing values are not allowed.
          type: boolean
        type:
          description: Forecast mode makes predictions using forecastPoint or rows
            in the dataset without target.
          enum:
          - forecast
          type: string
      required:
      - forecastPointPolicy
      - type
      type: object
    BatchPredictionJobTimeSeriesSettingsHistorical:
      properties:
        predictionsEndDate:
          description: Used for historical predictions in order to override date to
            which predictions should be calculated. By default value will be inferred
            automatically from the dataset.
          format: date-time
          type: string
        predictionsStartDate:
          description: Used for historical predictions in order to override date from
            which predictions should be calculated. By default value will be inferred
            automatically from the dataset.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          default: false
          description: If activated, missing values in the known in advance features
            are allowed in the forecast window at prediction time. If omitted or false,
            missing values are not allowed.
          type: boolean
        type:
          description: Historical mode enables bulk predictions which calculates predictions
            for all possible forecast points and forecast distances in the dataset
            within the predictionsStartDate/predictionsEndDate range.
          enum:
          - historical
          type: string
      required:
      - type
      type: object
    BatchPredictionJobTimeSeriesSettingsTraining:
      properties:
        relaxKnownInAdvanceFeaturesCheck:
          default: false
          description: If activated, missing values in the known in advance features
            are allowed in the forecast window at prediction time. If omitted or false,
            missing values are not allowed.
          type: boolean
        type:
          description: Forecast mode used for making predictions on subsets of training
            data.
          enum:
          - training
          type: string
      required:
      - type
      type: object
    BatchPredictionJobUpdate:
      properties:
        aborted:
          description: Time when job abortion happened
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.26
        completed:
          description: Time when job completed scoring
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.26
        failedRows:
          description: Number of rows that have failed scoring
          type: integer
          x-versionadded: v2.26
        hidden:
          description: Hides or unhides the job from the job list
          type: boolean
          x-versionadded: v2.24
        jobIntakeSize:
          description: Number of bytes in the intake dataset for this job
          nullable: true
          type: integer
          x-versionadded: v2.26
        jobOutputSize:
          description: Number of bytes in the output dataset for this job
          nullable: true
          type: integer
          x-versionadded: v2.26
        logs:
          description: The job log.
          items:
            description: A log line from the job log.
            type: string
          type: array
          x-versionadded: v2.26
        scoredRows:
          description: Number of rows that have been used in prediction computation
          type: integer
          x-versionadded: v2.26
        skippedRows:
          description: Number of rows that have been skipped during scoring. May contain
            non-zero value only in time-series predictions case if provided dataset
            contains more than required historical rows.
          type: integer
          x-versionadded: v2.26
        started:
          description: Time when job scoring begin
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.26
        status:
          description: The current job status
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          type: string
          x-versionadded: v2.26
      type: object
    BatchPredictionStatus:
      properties:
        processing:
          description: Number of jobs processing
          minimum: 0
          type: integer
        queued:
          description: Number of jobs queued
          minimum: 0
          type: integer
      required:
      - processing
      - queued
      type: object
    BiasAndFairness:
      properties:
        fairnessMetricsSet:
          description: A set of fairness metrics to use for calculating fairness.
          enum:
          - proportionalParity
          - equalParity
          - predictionBalance
          - trueFavorableAndUnfavorableRateParity
          - favorableAndUnfavorablePredictiveValueParity
          type: string
        fairnessThreshold:
          description: Threshold value of the fairness metric.
          maximum: 1
          minimum: 0
          type: number
        preferableTargetValue:
          anyOf:
          - type: boolean
          - type: integer
          - type: string
          description: A target value that should be treated as a positive outcome
            for the prediction.
        protectedFeatures:
          description: A list of feature to mark as protected for Bias and Fairness
            measurement.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - fairnessMetricsSet
      - fairnessThreshold
      - preferableTargetValue
      - protectedFeatures
      type: object
    BiasMitigatedModelsDataResponse:
      properties:
        biasMitigationTechnique:
          description: Method applied to perform bias mitigation.
          enum:
          - preprocessingReweighing
          - postProcessingRejectionOptionBasedClassification
          type: string
          x-versionadded: v2.27
        includeBiasMitigationFeatureAsPredictorVariable:
          description: Specifies whether the mitigation feature will be used as a
            predictor variable (i.e., treated like other categorical features in the
            input to train the modeler), in addition to being used for bias mitigation.
            If false, the mitigation feature will be used only for bias mitigation,
            and not for training the modeler task.
          type: boolean
          x-versionadded: v2.27
        modelId:
          description: Mitigated model ID
          type: string
        parentModelId:
          description: Parent model ID
          nullable: true
          type: string
        protectedFeature:
          description: Protected feature that will be used in a bias mitigation task
            to mitigate bias
          type: string
      required:
      - biasMitigationTechnique
      - includeBiasMitigationFeatureAsPredictorVariable
      - modelId
      - parentModelId
      - protectedFeature
      type: object
    BiasMitigatedModelsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Retrieve list of mitigated models for project.
          items:
            $ref: '#/components/schemas/BiasMitigatedModelsDataResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    BiasMitigationModelCreate:
      properties:
        biasMitigationFeature:
          description: The name of the protected feature used to mitigate bias on
            models.
          minLength: 1
          type: string
          x-versionadded: v2.27
        biasMitigationParentLid:
          description: The ID of the model to modify with a bias-mitigation task.
          type: string
        biasMitigationTechnique:
          description: Method applied to perform bias mitigation.
          enum:
          - preprocessingReweighing
          - postProcessingRejectionOptionBasedClassification
          type: string
          x-versionadded: v2.27
        includeBiasMitigationFeatureAsPredictorVariable:
          description: Specifies whether the mitigation feature will be used as a
            predictor variable (i.e., treated like other categorical features in the
            input to train the modeler), in addition to being used for bias mitigation.
            If false, the mitigation feature will be used only for bias mitigation,
            and not for training the modeler task.
          type: boolean
          x-versionadded: v2.27
      required:
      - biasMitigationFeature
      - biasMitigationParentLid
      - biasMitigationTechnique
      - includeBiasMitigationFeatureAsPredictorVariable
      type: object
    BiasVsAccuracyInsight:
      properties:
        accuracyMetric:
          description: The metric to return model accuracy scores. Defaults to the
            optimization metric configured in project options.
          enum:
          - AUC
          - Weighted AUC
          - Area Under PR Curve
          - Weighted Area Under PR Curve
          - Kolmogorov-Smirnov
          - Weighted Kolmogorov-Smirnov
          - FVE Binomial
          - Weighted FVE Binomial
          - Gini Norm
          - Weighted Gini Norm
          - LogLoss
          - Weighted LogLoss
          - Max MCC
          - Weighted Max MCC
          - Rate@Top5%
          - Weighted Rate@Top5%
          - Rate@Top10%
          - Weighted Rate@Top10%
          - Rate@TopTenth%
          - RMSE
          - Weighted RMSE
          type: string
        fairnessMetric:
          description: The fairness metric used to calculate the fairness scores.
          oneOf:
          - enum:
            - proportionalParity
            - equalParity
            - favorableClassBalance
            - unfavorableClassBalance
            - trueUnfavorableRateParity
            - trueFavorableRateParity
            - favorablePredictiveValueParity
            - unfavorablePredictiveValueParity
            type: string
          - items:
              enum:
              - proportionalParity
              - equalParity
              - favorableClassBalance
              - unfavorableClassBalance
              - trueUnfavorableRateParity
              - trueFavorableRateParity
              - favorablePredictiveValueParity
              - unfavorablePredictiveValueParity
              type: string
            type: array
        fairnessThreshold:
          default: 0.8
          description: Value of the fairness threshold, defined in project options.
          maximum: 1.0
          minimum: 0.0
          type: number
        models:
          description: An array of models of the insight.
          items:
            $ref: '#/components/schemas/BiasVsAccuracyModels'
          type: array
        protectedFeature:
          description: Name of the protected feature.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      required:
      - fairnessThreshold
      - models
      type: object
    BiasVsAccuracyInsightRetrieve:
      properties:
        data:
          description: An array of bias vs accuracy insights for the model.
          items:
            $ref: '#/components/schemas/BiasVsAccuracyInsight'
          type: array
      required:
      - data
      type: object
    BiasVsAccuracyModels:
      properties:
        accuracyValue:
          description: The model's accuracy score.
          minimum: 0.0
          type: number
        bp:
          description: The blueprint number of the model from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        dsName:
          description: The name of the feature list used for model training.
          type: string
        fairnessValue:
          description: The model's relative fairness score for the class with the
            lowest fairness score. In other words, the fairness score of the least
            privileged class.
          maximum: 1.0
          minimum: 0.0
          nullable: true
          type: number
        modelId:
          description: ID of the model.
          type: string
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        modelType:
          description: The type/name of the model.
          type: string
        prime:
          description: Flag to indicate whether the model is a prime model.
          type: boolean
        samplepct:
          description: The sample size percentage of the feature list data the model
            was trained on.
          maximum: 100.0
          minimum: 0.0
          type: number
      required:
      - accuracyValue
      - bp
      - dsName
      - fairnessValue
      - modelId
      - modelNumber
      - modelType
      - prime
      - samplepct
      type: object
    BigQueryDataStreamer:
      properties:
        bucket:
          description: The name of gcs bucket for data export
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the GCP credentials
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataset:
          description: The name of the specified big query dataset to read input data
            from
          type: string
        table:
          description: The name of the specified big query table to read input data
            from
          type: string
        type:
          description: Type name for this intake type
          enum:
          - bigquery
          type: string
      required:
      - bucket
      - credentialId
      - dataset
      - table
      - type
      type: object
    BigQueryIntake:
      properties:
        bucket:
          description: The name of gcs bucket for data export
          type: string
        credentialId:
          description: The ID of the GCP credentials
          type: string
        dataset:
          description: The name of the specified big query dataset to read input data
            from
          type: string
        table:
          description: The name of the specified big query table to read input data
            from
          type: string
        type:
          description: Type name for this intake type
          enum:
          - bigquery
          type: string
      required:
      - bucket
      - credentialId
      - dataset
      - table
      - type
      type: object
    BigQueryOutput:
      properties:
        bucket:
          description: The name of gcs bucket for data loading
          type: string
        credentialId:
          description: The ID of the GCP credentials
          type: string
        dataset:
          description: The name of the specified big query dataset to write data back
          type: string
        table:
          description: The name of the specified big query table to write data back
          type: string
        type:
          description: Type name for this output type
          enum:
          - bigquery
          type: string
      required:
      - bucket
      - credentialId
      - dataset
      - table
      - type
      type: object
    BigQueryOutputAdaptor:
      properties:
        bucket:
          description: The name of gcs bucket for data loading
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the GCP credentials
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataset:
          description: The name of the specified big query dataset to write data back
          type: string
        table:
          description: The name of the specified big query table to write data back
          type: string
        type:
          description: Type name for this output type
          enum:
          - bigquery
          type: string
      required:
      - bucket
      - credentialId
      - dataset
      - table
      - type
      type: object
    BinResponse:
      properties:
        avgPredicted:
          description: Average prediction of the model in the bin. Null if there are
            no entries in the bin.
          nullable: true
          type: number
        endDate:
          description: ISO-formatted datetime of the end of the bin (exclusive).
          format: date-time
          type: string
        frequency:
          description: Number of the rows in the bin.
          type: integer
        maxPredicted:
          description: Maximum prediction of the model in the bin. Null if there are
            no entries in the bin.
          nullable: true
          type: number
        startDate:
          description: ISO-formatted datetime of the start of the bin (inclusive).
          format: date-time
          type: string
      required:
      - avgPredicted
      - endDate
      - frequency
      - maxPredicted
      - startDate
      type: object
    BlenderCreate:
      properties:
        blenderMethod:
          description: The blender method, one of "PLS", "GLM", "AVG", "ENET", "MED",
            "MAE", "MAEL1", "TF", "RF", "LGBM", "FORECAST_DISTANCE_ENET" (new in v2.18),
            "FORECAST_DISTANCE_AVG" (new in v2.18), "MIN", "MAX".
          enum:
          - PLS
          - GLM
          - ENET
          - AVG
          - MED
          - MAE
          - MAEL1
          - FORECAST_DISTANCE_AVG
          - FORECAST_DISTANCE_ENET
          - MAX
          - MIN
          type: string
        modelIds:
          description: The list of models to use in blender.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - blenderMethod
      - modelIds
      type: object
    BlenderInfoRetrieveResponse:
      properties:
        blendable:
          description: If True, the models can be blended.
          type: boolean
        reason:
          description: Useful info as to why a model can't be blended.
          type: string
      required:
      - blendable
      - reason
      type: object
    BlenderListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Each has the same schema as if retrieving the model individually
            from :http:get:`/api/v2/projects/(projectId)/blenderModels/(modelId)/`.
          items:
            $ref: '#/components/schemas/BlenderRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    BlenderRetrieveResponse:
      properties:
        blenderMethod:
          description: Method used to blend results of underlying models.
          type: string
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
        dataSelectionMethod:
          description: Identifies which setting defines the training size of the model
            when making predictions and scoring. Only used by datetime models.
          enum:
          - duration
          - rowCount
          - selectedDateRange
          - useProjectSettings
          type: string
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        id:
          description: the ID of the model
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
        isNClustersDynamicallyDetermined:
          description: Whether number of clusters is dynamically determined. Only
            valid in unsupervised clustering projects.
          type: boolean
        isStarred:
          description: whether the model has been starred
          type: boolean
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          description: Object returning model lifecycle.
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          nullable: true
          type: string
          x-versionadded: v2.21
        metrics:
          description: the performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or null if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
        modelFamily:
          description: the family model belongs to, e.g. SVM, GBM, etc.
          type: string
          x-versionadded: v2.21
        modelFamilyFullName:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.31
        modelIds:
          description: List of models used in blender.
          items:
            type: string
          type: array
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
        monotonicDecreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        monotonicIncreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          nullable: true
          type: integer
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
        predictionThreshold:
          description: threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.13
        predictionThresholdReadOnly:
          description: indicates whether modification of a predictions threshold is
            forbidden. Since v2.22 threshold modification is allowed.
          type: boolean
          x-versionadded: v2.13
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
        projectId:
          description: the ID of the project to which the model belongs
          type: string
        samplePct:
          description: the percentage of the dataset used in training the model
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: number
        samplingMethod:
          description: indicates sampling method used to select training data in datetime
            models. For row-based project this is the way how requested number of
            rows are selected.For other projects (duration-based, start/end, project
            settings) - how specified percent of rows (timeWindowSamplePct) is selected
            from specified time window.
          enum:
          - random
          - latest
          type: string
        supportsComposableMl:
          description: indicates whether this model is supported in Composable ML.
          type: boolean
          x-versionadded: '2.26'
        supportsMonotonicConstraints:
          description: whether this model supports enforcing monotonic constraints
          type: boolean
          x-versionadded: v2.21
        timeWindowSamplePct:
          description: An integer between 1 and 99, indicating the percentage of sampling
            within the time window. The points kept are determined by samplingMethod
            option. Will be null if no sampling was specified. Only used by datetime
            models.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          nullable: true
          type: string
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          nullable: true
          type: string
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          nullable: true
          type: string
      required:
      - blenderMethod
      - blueprintId
      - featurelistId
      - featurelistName
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - lifecycle
      - linkFunction
      - metrics
      - modelCategory
      - modelFamily
      - modelFamilyFullName
      - modelIds
      - modelNumber
      - modelType
      - monotonicDecreasingFeaturelistId
      - monotonicIncreasingFeaturelistId
      - parentModelId
      - predictionThreshold
      - predictionThresholdReadOnly
      - processes
      - projectId
      - samplePct
      - supportsComposableMl
      - supportsMonotonicConstraints
      - trainingDuration
      - trainingEndDate
      - trainingRowCount
      - trainingStartDate
      type: object
    BlueprintChartRetrieveResponse:
      properties:
        edges:
          description: An array of chart edges - tuples of (start_id, end_id).
          items:
            items:
              type: string
            maxItems: 2
            minItems: 2
            type: array
          type: array
        nodes:
          description: An array of node descriptions.
          items:
            $ref: '#/components/schemas/NodeDescription'
          type: array
      required:
      - edges
      - nodes
      type: object
    BlueprintDocLinks:
      properties:
        name:
          description: The name of the documentation at the link.
          type: string
        url:
          description: The URL at which external documentation can be found.
          nullable: true
          type: string
      required:
      - name
      - url
      type: object
    BlueprintDocParameters:
      properties:
        description:
          description: A description of what the parameter does.
          type: string
        name:
          description: The name of the parameter.
          type: string
        type:
          description: The type (and default value) of the parameter.
          type: string
      required:
      - description
      - name
      - type
      type: object
    BlueprintDocReferences:
      properties:
        name:
          description: The name of the reference.
          type: string
        url:
          description: The URL at which the reference can be found.
          nullable: true
          type: string
      required:
      - name
      - url
      type: object
    BlueprintJsonResponse:
      properties:
        blueprint:
          description: JSON blueprint representation of the model.
          example: "\n                {\n                    \"1\": [[\"NUM\"], [\"\
            PNI2\"], \"T\"],\n                    \"2\": [[\"1\"], [\"LASSO2\"], \"\
            P\"],\n                }\n            "
          type: object
          x-versionadded: v2.31
      required:
      - blueprint
      type: object
    BlueprintListDocumentsResponse:
      properties:
        description:
          description: The task description.
          type: string
        links:
          description: A list of external documentation links.
          items:
            $ref: '#/components/schemas/BlueprintDocLinks'
          type: array
        parameters:
          description: An array of task parameters.
          items:
            $ref: '#/components/schemas/BlueprintDocParameters'
          type: array
        references:
          description: A list of reference links.
          items:
            $ref: '#/components/schemas/BlueprintDocReferences'
          type: array
        task:
          description: The task described in document.
          type: string
        title:
          description: The document title.
          type: string
      required:
      - description
      - links
      - parameters
      - references
      - task
      - title
      type: object
    BlueprintResponse:
      properties:
        blueprintCategory:
          description: describes the category of the blueprint and indicates the kind
            of model this blueprint produces. Will be either "DataRobot" or "Scaleout
            DataRobot".
          type: string
          x-versionadded: v2.6
        id:
          description: the blueprint ID of this blueprint - note that this is not
            an ObjectId.
          type: string
        isCustomModelBlueprint:
          description: Whether blueprint contains custom task.
          type: boolean
        modelType:
          description: the model this blueprint will produce.
          type: string
        monotonicDecreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.11
        monotonicIncreasingFeaturelistId:
          description: null or str, the ID of the featurelist that defines the set
            of features with a monotonically increasing relationship to the target.
            If null, no such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.11
        processes:
          description: a list of strings representing processes the blueprint uses.
          items:
            type: string
          type: array
        projectId:
          description: the project the blueprint belongs to.
          type: string
        recommendedFeaturelistId:
          description: The ID of the feature list recommended for this blueprint.
            If this field is not present, then there is no recommended feature list.
          nullable: true
          type: string
          x-versionadded: v2.18
        supportsComposableMl:
          description: indicates whether this blueprint is supported in Composable
            ML.
          type: boolean
          x-versionadded: v2.26
        supportsIncrementalLearning:
          description: Whether blueprint supports incremental learning.
          type: boolean
          x-versionadded: v2.32
        supportsMonotonicConstraints:
          description: whether this model supports enforcing monotonic constraints.
          type: boolean
          x-versionadded: v2.11
      required:
      - blueprintCategory
      - id
      - isCustomModelBlueprint
      - modelType
      - monotonicDecreasingFeaturelistId
      - monotonicIncreasingFeaturelistId
      - processes
      - projectId
      - supportsComposableMl
      - supportsIncrementalLearning
      - supportsMonotonicConstraints
      type: object
    BpData:
      properties:
        children:
          description: A nested dictionary representation of the blueprint DAG.
          items:
            $ref: '#/components/schemas/AllowExtra'
            description: A BpDataNode object, not listed here for compatibility with
              recursion.
          type: array
        id:
          description: The type of the node (e.g. "start", "input", "task").
          type: string
        inputs:
          description: The inputs to the current node.
          items:
            type: string
          type: array
        output:
          description: Ids describing the destination of any outgoing edges.
          oneOf:
          - description: Ids describing the destination of any outgoing edges.
            type: string
          - items:
              type: string
            maxItems: 0
            type: array
        taskMap:
          $ref: '#/components/schemas/AllowExtra'
          description: Metadata for each task and input data vertex
        taskParameters:
          description: A stringified JSON object describing the parameters and their
            values for a task.
          type: string
        tasks:
          description: The task defining the current node.
          items:
            type: string
          type: array
        type:
          description: A unique id to represent the current node.
          type: string
      required:
      - id
      - taskMap
      - taskParameters
      - tasks
      - type
      type: object
    BucketBatch:
      properties:
        createdAt:
          description: Timestamp when the batch was created.
          format: date-time
          type: string
          x-versionadded: v2.33
        id:
          description: DataRobot assigned ID of the batch.
          type: string
          x-versionadded: v2.33
        lastPredictionTimestamp:
          description: Timestamp when the latest prediction request of the batch was
            made
          format: date-time
          type: string
          x-versionadded: v2.33
        name:
          description: User provided name of the batch.
          type: string
          x-versionadded: v2.33
      required:
      - createdAt
      - id
      - name
      type: object
    BuildRecipeSql:
      properties:
        operations:
          description: 'List of operations to override the recipe operations when
            building SQL with default *null*. It doesn''t modify the recipe itself.
            Missing *operations* field or *null* give original recipe SQL. Empty *operations*
            list produces basic query of a format: `SELECT <list of columns> FROM
            <table name>`'
          items:
            $ref: '#/components/schemas/OneOfDirective'
          maxItems: 1000
          nullable: true
          type: array
          x-versionadded: v2.33
      type: object
    BuildRecipeSqlResponse:
      properties:
        sql:
          description: Generated sql.
          type: string
          x-versionadded: v2.33
      required:
      - sql
      type: object
    BulkCatalogAppendTagsPayload:
      properties:
        action:
          description: The action to execute on the datasets. Has to be 'tag' for
            this payload.
          enum:
          - tag
          type: string
        tags:
          description: The tags to append to the datasets. Tags will not be duplicated.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - action
      - tags
      type: object
    BulkCatalogDeletePayload:
      properties:
        action:
          description: The action to execute on the datasets. Has to be 'delete' for
            this payload.
          enum:
          - delete
          type: string
      required:
      - action
      type: object
    BulkCatalogSharePayload:
      properties:
        action:
          description: The action to execute on the datasets. Has to be 'updateRoles'
            for this payload.
          enum:
          - updateRoles
          type: string
        applyGrantToLinkedObjects:
          default: false
          description: If true for any users being granted access to the dataset,
            grant the user read access to any linked objects such as DataSources and
            DataStores that may be used by this dataset. Ignored if no such objects
            are relevant for dataset. Will not result in access being lowered for
            a user if the user already has higher access to linked objects than read
            access. However, if the target user does not have sharing permissions
            to the linked object, they will be given sharing access without lowering
            existing permissions. May result in an error if user making call does
            not have sufficient permissions to complete grant. Default value is false.
          type: boolean
        roles:
          description: An array of RoleRequest objects. May contain at most 100 such
            objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/DatasetRolesWithNames'
            - $ref: '#/components/schemas/DatasetRolesWithId'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - action
      - roles
      type: object
    BulkDatasetAction:
      properties:
        datasetIds:
          description: The dataset IDs to execute the bulk action on.
          items:
            type: string
          minItems: 1
          type: array
        payload:
          description: indicate which action to run and with what parameters.
          oneOf:
          - $ref: '#/components/schemas/BulkCatalogDeletePayload'
          - $ref: '#/components/schemas/BulkCatalogAppendTagsPayload'
          - $ref: '#/components/schemas/BulkCatalogSharePayload'
      required:
      - datasetIds
      - payload
      type: object
    CalendarAccessControlListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          minimum: 0
          type: integer
        data:
          description: Records of users and their roles on the calendar.
          items:
            $ref: '#/components/schemas/CalendarUserRoleRecordResponse'
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    CalendarAccessControlUpdate:
      properties:
        users:
          description: The list of users and their updated roles used to modify the
            access for this calendar.
          items:
            $ref: '#/components/schemas/CalendarUsernameRole'
            description: Each item in `users` refers to the username record and its
              newly assigned role.
          maxItems: 100
          type: array
      required:
      - users
      type: object
    CalendarEvent:
      properties:
        date:
          description: The date of the calendar event.
          format: date-time
          type: string
        name:
          description: Name of the calendar event.
          type: string
        seriesId:
          description: The series ID for the event. If this event does not specify
            a series ID, then this will be `null`, indicating that the event applies
            to all series.
          nullable: true
          type: string
      required:
      - date
      - name
      - seriesId
      type: object
    CalendarEventsResponseQuery:
      properties:
        count:
          description: The number of items returned on this page.
          minimum: 0
          type: integer
        data:
          description: An array of calendar events
          items:
            $ref: '#/components/schemas/CalendarEvent'
          maxItems: 1000
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    CalendarFileUpload:
      properties:
        file:
          description: 'The calendar file used to create a calendar. The calendar
            file expect to meet the following criteria:


            Must be in a csv or xlsx format.


            Must have a header row. The names themselves in the header row can be
            anything.


            Must have a single date column, in YYYY-MM-DD format.


            May optionally have a name column as the second column.


            May optionally have one series ID column that states what series each
            event is applicable for. If present, the name of this column must be specified
            in the `multiseriesIdColumns` parameter.'
          format: binary
          type: string
        multiseriesIdColumns:
          description: An array of multiseries ID column names for the calendar file.
            Currently only one multiseries ID column is supported. If not specified,
            the calendar is considered to be single series.
          type: string
          x-versionadded: v2.19
        name:
          description: The name of the calendar file. If not provided, this will be
            set to the name of the provided file.
          type: string
      required:
      - file
      type: object
    CalendarFromDataset:
      properties:
        datasetId:
          description: The ID of the dataset from which to create the calendar.
          type: string
        datasetVersionId:
          description: The ID of the dataset version from which to create the calendar.
          type: string
        deleteOnError:
          description: Whether delete calendar file from Catalog if it's not valid.
          type: boolean
        multiseriesIdColumns:
          description: Optional multiseries id columns for calendar.
          items:
            type: string
          maxItems: 1
          type: array
        name:
          description: Optional name for catalog.
          type: string
      required:
      - datasetId
      type: object
    CalendarListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          minimum: 0
          type: integer
        data:
          description: An array of calendars, each in the form described under :http:get:`/api/v2/calendars/`.
          items:
            $ref: '#/components/schemas/CalendarRecord'
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    CalendarNameUpdate:
      properties:
        name:
          description: The new name to assign to the calendar.
          type: string
      required:
      - name
      type: object
    CalendarRecord:
      properties:
        created:
          description: An ISO-8601 string with the time that this calendar was created.
          format: date-time
          type: string
        datetimeFormat:
          description: The datetime format detected for the uploaded calendar file.
          enum:
          - '%m/%d/%Y'
          - '%m/%d/%y'
          - '%d/%m/%y'
          - '%m-%d-%Y'
          - '%m-%d-%y'
          - '%Y/%m/%d'
          - '%Y-%m-%d'
          - '%Y-%m-%d %H:%M:%S'
          - '%Y/%m/%d %H:%M:%S'
          - '%Y.%m.%d %H:%M:%S'
          - '%Y-%m-%d %H:%M'
          - '%Y/%m/%d %H:%M'
          - '%y/%m/%d'
          - '%y-%m-%d'
          - '%y-%m-%d %H:%M:%S'
          - '%y.%m.%d %H:%M:%S'
          - '%y/%m/%d %H:%M:%S'
          - '%y-%m-%d %H:%M'
          - '%y.%m.%d %H:%M'
          - '%y/%m/%d %H:%M'
          - '%m/%d/%Y %H:%M'
          - '%m/%d/%y %H:%M'
          - '%d/%m/%Y %H:%M'
          - '%d/%m/%y %H:%M'
          - '%m-%d-%Y %H:%M'
          - '%m-%d-%y %H:%M'
          - '%d-%m-%Y %H:%M'
          - '%d-%m-%y %H:%M'
          - '%m.%d.%Y %H:%M'
          - '%m/%d.%y %H:%M'
          - '%d.%m.%Y %H:%M'
          - '%d.%m.%y %H:%M'
          - '%m/%d/%Y %H:%M:%S'
          - '%m/%d/%y %H:%M:%S'
          - '%m-%d-%Y %H:%M:%S'
          - '%m-%d-%y %H:%M:%S'
          - '%m.%d.%Y %H:%M:%S'
          - '%m.%d.%y %H:%M:%S'
          - '%d/%m/%Y %H:%M:%S'
          - '%d/%m/%y %H:%M:%S'
          - '%Y-%m-%d %H:%M:%S.%f'
          - '%y-%m-%d %H:%M:%S.%f'
          - '%Y-%m-%dT%H:%M:%S.%fZ'
          - '%y-%m-%dT%H:%M:%S.%fZ'
          - '%Y-%m-%dT%H:%M:%S.%f'
          - '%y-%m-%dT%H:%M:%S.%f'
          - '%Y-%m-%dT%H:%M:%S'
          - '%y-%m-%dT%H:%M:%S'
          - '%Y-%m-%dT%H:%M:%SZ'
          - '%y-%m-%dT%H:%M:%SZ'
          - '%Y.%m.%d %H:%M:%S.%f'
          - '%y.%m.%d %H:%M:%S.%f'
          - '%Y.%m.%dT%H:%M:%S.%fZ'
          - '%y.%m.%dT%H:%M:%S.%fZ'
          - '%Y.%m.%dT%H:%M:%S.%f'
          - '%y.%m.%dT%H:%M:%S.%f'
          - '%Y.%m.%dT%H:%M:%S'
          - '%y.%m.%dT%H:%M:%S'
          - '%Y.%m.%dT%H:%M:%SZ'
          - '%y.%m.%dT%H:%M:%SZ'
          - '%Y%m%d'
          - '%m %d %Y %H %M %S'
          - '%m %d %y %H %M %S'
          - '%H:%M'
          - '%M:%S'
          - '%H:%M:%S'
          - '%Y %m %d %H %M %S'
          - '%y %m %d %H %M %S'
          - '%Y %m %d'
          - '%y %m %d'
          - '%d/%m/%Y'
          - '%Y-%d-%m'
          - '%y-%d-%m'
          - '%Y/%d/%m %H:%M:%S.%f'
          - '%Y/%d/%m %H:%M:%S.%fZ'
          - '%Y/%m/%d %H:%M:%S.%f'
          - '%Y/%m/%d %H:%M:%S.%fZ'
          - '%y/%d/%m %H:%M:%S.%f'
          - '%y/%d/%m %H:%M:%S.%fZ'
          - '%y/%m/%d %H:%M:%S.%f'
          - '%y/%m/%d %H:%M:%S.%fZ'
          - '%m.%d.%Y'
          - '%m.%d.%y'
          - '%d.%m.%y'
          - '%d.%m.%Y'
          - '%Y.%m.%d'
          - '%Y.%d.%m'
          - '%y.%m.%d'
          - '%y.%d.%m'
          - '%Y-%m-%d %I:%M:%S %p'
          - '%Y/%m/%d %I:%M:%S %p'
          - '%Y.%m.%d %I:%M:%S %p'
          - '%Y-%m-%d %I:%M %p'
          - '%Y/%m/%d %I:%M %p'
          - '%y-%m-%d %I:%M:%S %p'
          - '%y.%m.%d %I:%M:%S %p'
          - '%y/%m/%d %I:%M:%S %p'
          - '%y-%m-%d %I:%M %p'
          - '%y.%m.%d %I:%M %p'
          - '%y/%m/%d %I:%M %p'
          - '%m/%d/%Y %I:%M %p'
          - '%m/%d/%y %I:%M %p'
          - '%d/%m/%Y %I:%M %p'
          - '%d/%m/%y %I:%M %p'
          - '%m-%d-%Y %I:%M %p'
          - '%m-%d-%y %I:%M %p'
          - '%d-%m-%Y %I:%M %p'
          - '%d-%m-%y %I:%M %p'
          - '%m.%d.%Y %I:%M %p'
          - '%m/%d.%y %I:%M %p'
          - '%d.%m.%Y %I:%M %p'
          - '%d.%m.%y %I:%M %p'
          - '%m/%d/%Y %I:%M:%S %p'
          - '%m/%d/%y %I:%M:%S %p'
          - '%m-%d-%Y %I:%M:%S %p'
          - '%m-%d-%y %I:%M:%S %p'
          - '%m.%d.%Y %I:%M:%S %p'
          - '%m.%d.%y %I:%M:%S %p'
          - '%d/%m/%Y %I:%M:%S %p'
          - '%d/%m/%y %I:%M:%S %p'
          - '%Y-%m-%d %I:%M:%S.%f %p'
          - '%y-%m-%d %I:%M:%S.%f %p'
          - '%Y-%m-%dT%I:%M:%S.%fZ %p'
          - '%y-%m-%dT%I:%M:%S.%fZ %p'
          - '%Y-%m-%dT%I:%M:%S.%f %p'
          - '%y-%m-%dT%I:%M:%S.%f %p'
          - '%Y-%m-%dT%I:%M:%S %p'
          - '%y-%m-%dT%I:%M:%S %p'
          - '%Y-%m-%dT%I:%M:%SZ %p'
          - '%y-%m-%dT%I:%M:%SZ %p'
          - '%Y.%m.%d %I:%M:%S.%f %p'
          - '%y.%m.%d %I:%M:%S.%f %p'
          - '%Y.%m.%dT%I:%M:%S.%fZ %p'
          - '%y.%m.%dT%I:%M:%S.%fZ %p'
          - '%Y.%m.%dT%I:%M:%S.%f %p'
          - '%y.%m.%dT%I:%M:%S.%f %p'
          - '%Y.%m.%dT%I:%M:%S %p'
          - '%y.%m.%dT%I:%M:%S %p'
          - '%Y.%m.%dT%I:%M:%SZ %p'
          - '%y.%m.%dT%I:%M:%SZ %p'
          - '%m %d %Y %I %M %S %p'
          - '%m %d %y %I %M %S %p'
          - '%I:%M %p'
          - '%I:%M:%S %p'
          - '%Y %m %d %I %M %S %p'
          - '%y %m %d %I %M %S %p'
          - '%Y/%d/%m %I:%M:%S.%f %p'
          - '%Y/%d/%m %I:%M:%S.%fZ %p'
          - '%Y/%m/%d %I:%M:%S.%f %p'
          - '%Y/%m/%d %I:%M:%S.%fZ %p'
          - '%y/%d/%m %I:%M:%S.%f %p'
          - '%y/%d/%m %I:%M:%S.%fZ %p'
          - '%y/%m/%d %I:%M:%S.%f %p'
          - '%y/%m/%d %I:%M:%S.%fZ %p'
          type: string
          x-versionadded: v2.26
        earliestEvent:
          description: An ISO-8601 date string of the earliest event seen in this
            calendar.
          format: date-time
          type: string
        id:
          description: The ID of this calendar.
          type: string
        latestEvent:
          description: An ISO-8601 date string of the latest event seen in this calendar.
          format: date-time
          type: string
        multiseriesIdColumns:
          description: An array of multiseries ID column names in this calendar file.
            Currently only one multiseries ID column is supported. Will be `null`
            if this calendar is single-series.
          items:
            type: string
          maxItems: 1
          nullable: true
          type: array
          x-versionadded: v2.19
        name:
          description: The name of this calendar. This will be the same as `source`
            if no name was specified when the calendar was created.
          type: string
        numEventTypes:
          description: The number of distinct eventTypes in this calendar.
          type: integer
        numEvents:
          description: The number of dates that are marked as having an event in this
            calendar.
          type: integer
        projectId:
          description: The project IDs of projects currently using this calendar.
          items:
            type: string
          type: array
        role:
          description: The role the requesting user has on this calendar.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        source:
          description: The name of the source file that was used to create this calendar.
          type: string
      required:
      - created
      - datetimeFormat
      - earliestEvent
      - id
      - latestEvent
      - multiseriesIdColumns
      - name
      - numEventTypes
      - numEvents
      - projectId
      - role
      - source
      type: object
    CalendarUserRoleRecordResponse:
      properties:
        canShare:
          description: Whether this user can share this calendar with other users.
          type: boolean
        role:
          description: The role of the user on this calendar.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        userId:
          description: The ID of the user.
          type: string
        username:
          description: The username of a user with access to this calendar.
          type: string
      required:
      - canShare
      - role
      - userId
      - username
      type: object
    CalendarUsernameRole:
      properties:
        role:
          description: The new role to assign to the specified user.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          nullable: true
          type: string
        username:
          description: The username of the user to modify access for.
          type: string
      required:
      - role
      - username
      type: object
    Catalog:
      properties:
        datasetId:
          description: The ID of the AI catalog dataset
          type: string
        datasetVersionId:
          description: The ID of the AI catalog dataset version
          type: string
        type:
          description: Type name for this intake type
          enum:
          - dataset
          type: string
      required:
      - datasetId
      - type
      type: object
    CatalogDataStreamer:
      properties:
        datasetId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the AI catalog dataset
            type: string
          - enum:
            - '[redacted]'
            type: string
        datasetVersionId:
          description: The ID of the AI catalog dataset version
          type: string
        type:
          description: Type name for this intake type
          enum:
          - dataset
          type: string
      required:
      - datasetId
      - type
      type: object
    CatalogDetailsRetrieveResponse:
      properties:
        createdAt:
          description: The ISO 8601-formatted date and time indicating when this item
            was created in the catalog.
          format: date-time
          type: string
        createdBy:
          description: The full name or username of the user who added this item to
            the catalog.
          type: string
        description:
          description: Catalog item description.
          nullable: true
          type: string
        id:
          description: Catalog item ID.
          type: string
        message:
          description: Details of exception(s) raised during ingestion process, if
            any.
          nullable: true
          type: string
        modifiedAt:
          description: The ISO 8601-formatted date and time indicating changes to
            the Info field(s) of this catalog item.
          format: date-time
          type: string
        modifiedBy:
          description: The full name or username of the user who last modified the
            Info field(s) of this catalog item.
          type: string
        name:
          description: Catalog item name.
          type: string
        status:
          description: For datasets, the current ingestion process state of this catalog
            item.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          nullable: true
          type: string
        tags:
          description: List of catalog item tags in the lower case with no spaces.
          items:
            type: string
          type: array
        type:
          description: Catalog item type.
          enum:
          - unknown_dataset_type
          - snapshot_dataset
          - remote_dataset
          - unknown_catalog_type
          - user_blueprint
          type: string
      required:
      - createdAt
      - createdBy
      - description
      - id
      - message
      - modifiedAt
      - modifiedBy
      - name
      - status
      - tags
      - type
      type: object
    CatalogExtendedDetailsDataOriginResponse:
      properties:
        canShareDatasetData:
          description: Indicates if the dataset data can be shared.
          type: boolean
          x-versionadded: v2.30
        canUseDatasetData:
          description: Indicates if the dataset data can be used.
          type: boolean
          x-versionadded: v2.23
        catalogName:
          description: Catalog item name.
          type: string
        catalogType:
          description: Catalog item type.
          enum:
          - unknown_dataset_type
          - snapshot_dataset
          - remote_dataset
          - unknown_catalog_type
          - user_blueprint
          type: string
        dataEngineQueryId:
          description: The ID of the catalog item data engine query.
          nullable: true
          type: string
        dataOrigin:
          description: Data origin of the datasource for this catalog item.
          nullable: true
          type: string
        dataSourceId:
          description: The ID of the catalog item data source.
          nullable: true
          type: string
        description:
          description: Catalog item description.
          nullable: true
          type: string
        error:
          description: The latest error of the catalog item.
          nullable: true
          type: string
        id:
          description: Catalog item ID.
          type: string
        infoCreationDate:
          description: The creation date of the catalog item.
          type: string
        infoCreatorFullName:
          description: The creator of the catalog item.
          type: string
        infoModificationDate:
          description: The date when the dataset metadata was last modified. This
            field is only applicable if the catalog item is a dataset.
          type: string
        infoModifierFullName:
          description: The user that last modified the dataset metadata. This field
            is only applicable if the catalog item is a dataset.
          nullable: true
          type: string
        isDataEngineEligible:
          description: Indicates if the catalog item is eligible for use by the data
            engine.
          type: boolean
          x-versionadded: v2.21
        isFirstVersion:
          description: Indicates if the catalog item is the first version.
          type: boolean
        lastModificationDate:
          description: The date when the catalog item was last modified.
          type: string
        lastModifierFullName:
          description: The user that last modified the catalog item.
          type: string
        originalName:
          description: Catalog item original name.
          type: string
        processingState:
          description: The latest processing state of the catalog item.
          nullable: true
          type: integer
        projectsUsedInCount:
          description: The number of projects that use the catalog item.
          type: integer
        recipeId:
          description: The ID of the catalog item recipe.
          nullable: true
          type: string
        relevance:
          description: ElasticSearch score value or null if search done in Mongo.
          nullable: true
          type: number
        tags:
          description: List of catalog item tags in the lower case with no spaces.
          items:
            type: string
          type: array
        uri:
          description: The URI to the datasource from which the catalog item was created,
            if it is a dataset.
          nullable: true
          type: string
        userBlueprintId:
          description: The ID by which a user blueprint is referenced in User Blueprint
            API.
          nullable: true
          type: string
          x-versionadded: v2.25
      required:
      - canShareDatasetData
      - canUseDatasetData
      - catalogName
      - catalogType
      - dataEngineQueryId
      - dataOrigin
      - dataSourceId
      - description
      - error
      - id
      - infoCreationDate
      - infoCreatorFullName
      - infoModificationDate
      - infoModifierFullName
      - isDataEngineEligible
      - lastModificationDate
      - lastModifierFullName
      - originalName
      - processingState
      - projectsUsedInCount
      - recipeId
      - relevance
      - tags
      - uri
      - userBlueprintId
      type: object
    CatalogExtendedDetailsResponse:
      properties:
        canShareDatasetData:
          description: Indicates if the dataset data can be shared.
          type: boolean
          x-versionadded: v2.30
        canUseDatasetData:
          description: Indicates if the dataset data can be used.
          type: boolean
          x-versionadded: v2.23
        catalogName:
          description: Catalog item name.
          type: string
        catalogType:
          description: Catalog item type.
          enum:
          - unknown_dataset_type
          - snapshot_dataset
          - remote_dataset
          - unknown_catalog_type
          - user_blueprint
          type: string
        dataEngineQueryId:
          description: The ID of the catalog item data engine query.
          nullable: true
          type: string
        dataSourceId:
          description: The ID of the catalog item data source.
          nullable: true
          type: string
        description:
          description: Catalog item description.
          nullable: true
          type: string
        error:
          description: The latest error of the catalog item.
          nullable: true
          type: string
        id:
          description: Catalog item ID.
          type: string
        infoCreationDate:
          description: The creation date of the catalog item.
          type: string
        infoCreatorFullName:
          description: The creator of the catalog item.
          type: string
        infoModificationDate:
          description: The date when the dataset metadata was last modified. This
            field is only applicable if the catalog item is a dataset.
          type: string
        infoModifierFullName:
          description: The user that last modified the dataset metadata. This field
            is only applicable if the catalog item is a dataset.
          nullable: true
          type: string
        isDataEngineEligible:
          description: Indicates if the catalog item is eligible for use by the data
            engine.
          type: boolean
          x-versionadded: v2.21
        isFirstVersion:
          description: Indicates if the catalog item is the first version.
          type: boolean
        lastModificationDate:
          description: The date when the catalog item was last modified.
          type: string
        lastModifierFullName:
          description: The user that last modified the catalog item.
          type: string
        originalName:
          description: Catalog item original name.
          type: string
        processingState:
          description: The latest processing state of the catalog item.
          nullable: true
          type: integer
        projectsUsedInCount:
          description: The number of projects that use the catalog item.
          type: integer
        recipeId:
          description: The ID of the catalog item recipe.
          nullable: true
          type: string
        relevance:
          description: ElasticSearch score value or null if search done in Mongo.
          nullable: true
          type: number
        tags:
          description: List of catalog item tags in the lower case with no spaces.
          items:
            type: string
          type: array
        uri:
          description: The URI to the datasource from which the catalog item was created,
            if it is a dataset.
          nullable: true
          type: string
        userBlueprintId:
          description: The ID by which a user blueprint is referenced in User Blueprint
            API.
          nullable: true
          type: string
          x-versionadded: v2.25
      required:
      - canShareDatasetData
      - canUseDatasetData
      - catalogName
      - catalogType
      - dataEngineQueryId
      - dataSourceId
      - description
      - error
      - id
      - infoCreationDate
      - infoCreatorFullName
      - infoModificationDate
      - infoModifierFullName
      - isDataEngineEligible
      - lastModificationDate
      - lastModifierFullName
      - originalName
      - processingState
      - projectsUsedInCount
      - recipeId
      - relevance
      - tags
      - uri
      - userBlueprintId
      type: object
    CatalogListSearchResponse:
      properties:
        cacheHit:
          description: Indicates if the catalog item is returned from the cache.
          nullable: true
          type: boolean
        count:
          description: Number of catalog items returned on this page.
          type: integer
        data:
          description: Detailed information for every found catalog item.
          items:
            $ref: '#/components/schemas/CatalogExtendedDetailsDataOriginResponse'
          type: array
        next:
          description: Location of the next page.
          nullable: true
          type: string
        previous:
          description: Location of the previous page.
          nullable: true
          type: string
        totalCount:
          description: Total number of catalog items.
          type: integer
      required:
      - cacheHit
      - count
      - data
      - next
      - previous
      type: object
    CatalogPasswordCredentials:
      properties:
        catalogVersionId:
          description: Identifier of the catalog version
          type: string
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server side as part of the HTTP request
            and never saved or stored. '
          type: string
        url:
          description: URL that is subject to credentials.
          type: string
        user:
          description: The username for database authentication.
          type: string
      required:
      - password
      - user
      type: object
    Categorical:
      properties:
        allData:
          $ref: '#/components/schemas/PerValueStatistics'
          description: Statistics for all data for different feature values.
        insightName:
          description: Insight name.
          enum:
          - categoryLevelFrequencyPercent
          type: string
        perCluster:
          description: Statistic values for different feature values in this cluster.
          items:
            $ref: '#/components/schemas/PerClusterCategorical'
          type: array
      required:
      - allData
      - insightName
      - perCluster
      type: object
    CategoricalFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          nullable: true
          type: number
        featureName:
          description: Feature name.
          type: string
        featureType:
          description: Feature Type.
          enum:
          - categorical
          type: string
        insights:
          description: A list of Cluster Insights for a feature.
          items:
            $ref: '#/components/schemas/Categorical'
          type: array
      required:
      - featureName
      - featureType
      - insights
      type: object
    CategoricalStatsArguments:
      properties:
        methods:
          description: 'Window method: most-frequent'
          items:
            enum:
            - most-frequent
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
        windowSize:
          description: Rolling window size, defined in terms of rows. Left end is
            exclusive, right end is inclusive.
          exclusiveMinimum: true
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - methods
      - windowSize
      type: object
    ChallengerCreate:
      properties:
        modelPackageId:
          description: ID of the model package to add as a challenger.
          type: string
        name:
          description: Human-readable name for the challenger.
          maxLength: 512
          type: string
        predictionEnvironmentId:
          description: ID of the Prediction Environment the challenger should use.
            If prediction environments are enabled, this is required
          type: string
      required:
      - modelPackageId
      - name
      type: object
    ChallengerListResponse:
      properties:
        data:
          description: List of challengers.
          items:
            $ref: '#/components/schemas/ChallengerResponse'
          type: array
      required:
      - data
      type: object
    ChallengerResponse:
      properties:
        id:
          description: ID of the challenger.
          type: string
        model:
          $ref: '#/components/schemas/ModelResponse'
          description: Model of the challenger.
        modelPackage:
          $ref: '#/components/schemas/ModelPackageResponse'
          description: modelPackage of the challenger.
        name:
          description: Name of the challenger.
          type: string
        predictionEnvironment:
          $ref: '#/components/schemas/PredictionEnvironmentResponse'
          description: Prediction environment used by the challenger
      required:
      - id
      - model
      - modelPackage
      - name
      type: object
    ChallengerScore:
      properties:
        timestamp:
          description: The date and time in ISO8601 format, challenger models will
            be scored on data starting from deployment creation until timestamp. If
            not specified UTC current time is used.
          format: date-time
          type: string
      type: object
    ChallengerUpdate:
      properties:
        name:
          description: Human-readable name for the challenger.
          maxLength: 512
          type: string
        predictionEnvironmentId:
          description: ID of the Prediction Environment the challenger should use.
          type: string
      type: object
    Challengers:
      properties:
        enabled:
          description: Indicates whether challenger models are enabled for the deployment.
          type: boolean
      required:
      - enabled
      type: object
    ChallengersReplaySettings:
      properties:
        enabled:
          description: Identifies whether scheduled replay is enabled.
          type: boolean
          x-versionadded: v2.33
        schedule:
          $ref: '#/components/schemas/Schedule'
          description: Schedule settings
          x-versionadded: v2.33
      type: object
    ChangeRequestCreate:
      discriminator:
        propertyName: action
      oneOf:
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - approve
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentApproveChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - changeStatus
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentChangeStatusChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - changeImportance
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentChangeImportanceChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - cleanupStats
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentCleanupStatsChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - delete
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentDeleteChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - replaceModel
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentReplaceModelChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - replaceModelPackage
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentReplaceModelPackageChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
      - properties:
          action:
            description: Actions the user can take on the entity. Each entity type
              has a specific set of actions.
            enum:
            - updateSecondaryDatasetConfigs
            type: string
          autoApply:
            default: false
            description: Whether to automatically apply the change when the request
              is approved. If `true`, the requested changes will be applied on approval.
            type: boolean
          change:
            $ref: '#/components/schemas/DeploymentUpdateSecondaryDatasetConfigChange'
            description: 'Change that the user wants to apply to the entity. Needs
              to be provided if the action, like `approve` action for a deployment,
              requires additional parameters . `null` if the action does not require
              any additional parameters to be applied. '
          comment:
            description: Free form text to comment on the requested changes.
            maxLength: 10000
            type: string
          entityId:
            description: ID of the Product Entity the request is intended to change.
            type: string
          entityType:
            description: Type of the Product Entity that is requested to be changed.
            enum:
            - deployment
            - Deployment
            - DEPLOYMENT
            type: string
        required:
        - action
        - autoApply
        - change
        - entityId
        - entityType
        type: object
    ChangeRequestDiff:
      properties:
        changesFrom:
          description: List of human readable messages describing the state of the
            entity before changes are applied.
          items:
            description: Single message line.
            type: string
          maxItems: 1000
          type: array
        changesTo:
          description: List of human readable messages describing the state of the
            entity after changes are applied.
          items:
            description: Single message line.
            type: string
          maxItems: 1000
          type: array
      required:
      - changesFrom
      - changesTo
      type: object
    ChangeRequestInfoListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of Approval Policies.
          items:
            $ref: '#/components/schemas/ChangeRequestInfoResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ChangeRequestInfoResponse:
      properties:
        changeRequestId:
          description: ID of the Change Request.
          type: string
        createDate:
          description: Change Request creation date.
          format: date-time
          type: string
        entityId:
          description: ID of the modified entity.
          type: string
        entityName:
          description: Name of the modified entity.
          nullable: true
          type: string
        requester:
          description: Username of the account that initiated a Change Request.
          type: string
        state:
          description: Status of the Change Request.
          enum:
          - OPENED
          - RESOLVED
          - CANCELLED
          type: string
        updateDate:
          description: Last date when Change Request was modified.
          format: date-time
          nullable: true
          type: string
        updatedBy:
          description: Username of the account that last updated the Change Request.
          nullable: true
          type: string
      required:
      - changeRequestId
      - createDate
      - entityId
      - entityName
      - requester
      - state
      - updateDate
      - updatedBy
      type: object
    ChangeRequestResponse:
      properties:
        action:
          description: Actions the user can take on the entity. Each entity type has
            a specific set of actions.
          enum:
          - approve
          - Approve
          - APPROVE
          - changeStatus
          - ChangeStatus
          - CHANGE_STATUS
          - changeImportance
          - ChangeImportance
          - CHANGE_IMPORTANCE
          - cleanupStats
          - CleanupStats
          - CLEANUP_STATS
          - delete
          - Delete
          - DELETE
          - replaceModel
          - ReplaceModel
          - REPLACE_MODEL
          - replaceModelPackage
          - ReplaceModelPackage
          - REPLACE_MODEL_PACKAGE
          - updateSecondaryDatasetConfigs
          - UpdateSecondaryDatasetConfigs
          - UPDATE_SECONDARY_DATASET_CONFIGS
          type: string
        autoApply:
          default: false
          description: Whether to automatically apply the change when the request
            is approved. If `true`, the requested changes will be applied on approval.
          type: boolean
        change:
          description: 'Change that the user wants to apply to the entity. Needs to
            be provided if the action, like `approve` action for a deployment, requires
            additional parameters . `null` if the action does not require any additional
            parameters to be applied. '
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/DeploymentApproveChange'
          - $ref: '#/components/schemas/DeploymentChangeStatusChange'
          - $ref: '#/components/schemas/DeploymentChangeImportanceChange'
          - $ref: '#/components/schemas/DeploymentCleanupStatsChange'
          - $ref: '#/components/schemas/DeploymentReplaceModelChange'
          - $ref: '#/components/schemas/DeploymentReplaceModelPackageChange'
          - $ref: '#/components/schemas/DeploymentUpdateSecondaryDatasetConfigChange'
        changeVersionId:
          description: ID of the current version of change within this Change Request.
            It's possible to modify the changes that have been requested. At the same
            time, we need to make sure that review is associated with the correct
            changes, that's why we implement versioning on the changes and associate
            user reviews with the specific Change Request versions.
          type: string
        comment:
          description: Free form text to comment on the requested changes.
          maxLength: 10000
          type: string
        createdAt:
          description: Timestamp when the request was created.
          format: date-time
          type: string
        diff:
          $ref: '#/components/schemas/ChangeRequestDiff'
          description: The difference between the current entity state and the state
            of the entity if the Change Request gets applied.
        entityId:
          description: ID of the Product Entity the request is intended to change.
          type: string
        entityType:
          description: Type of the Product Entity that is requested to be changed.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
        id:
          description: ID of the Change Request.
          type: string
        numApprovalsRequired:
          description: Number of approving reviews required for the Change Request
            to be considered approved.
          minimum: 0
          type: integer
        processedAt:
          description: Timestamp when the request was processed.
          format: date-time
          nullable: true
          type: string
        status:
          description: Change Request Status.
          enum:
          - pending
          - Pending
          - PENDING
          - approved
          - Approved
          - APPROVED
          - changesRequested
          - ChangesRequested
          - CHANGES_REQUESTED
          - resolved
          - Resolved
          - RESOLVED
          - cancelled
          - Cancelled
          - CANCELLED
          type: string
        statusChangedAt:
          description: Timestamp when the current request status was set. `null` if
            status is set by the system.
          format: date-time
          nullable: true
          type: string
        statusChangedBy:
          description: ID of the user who set the current request status. `null` if
            the status was set by the system.
          nullable: true
          type: string
        updatedAt:
          description: Timestamp when the request was last modified.
          format: date-time
          type: string
        userId:
          description: ID of the user, who created the Change Request.
          type: string
        userName:
          description: Email of the user, who created the Change Request
          nullable: true
          type: string
        userOperations:
          $ref: '#/components/schemas/UserOperations'
          description: A set operations the user can or can not make with the Change
            Request.
      required:
      - action
      - autoApply
      - change
      - changeVersionId
      - createdAt
      - diff
      - entityId
      - entityType
      - id
      - numApprovalsRequired
      - processedAt
      - status
      - statusChangedAt
      - statusChangedBy
      - updatedAt
      - userId
      - userName
      - userOperations
      type: object
    ChangeRequestUpdate:
      properties:
        autoApply:
          description: Whether to automatically apply the change when the request
            is approved. If `true`, the requested changes will be applied on approval.
          type: boolean
        change:
          description: 'Change that the user wants to apply to the entity. Needs to
            be provided if the action, like `approve` action for a deployment, requires
            additional parameters . `null` if the action does not require any additional
            parameters to be applied. '
          oneOf:
          - $ref: '#/components/schemas/DeploymentApproveChange'
          - $ref: '#/components/schemas/DeploymentChangeStatusChange'
          - $ref: '#/components/schemas/DeploymentChangeImportanceChange'
          - $ref: '#/components/schemas/DeploymentCleanupStatsChange'
          - $ref: '#/components/schemas/DeploymentReplaceModelChange'
          - $ref: '#/components/schemas/DeploymentReplaceModelPackageChange'
          - $ref: '#/components/schemas/DeploymentUpdateSecondaryDatasetConfigChange'
        comment:
          description: Free form text to comment on the requested changes.
          maxLength: 10000
          type: string
      type: object
    ChangeRequestUpdateStatus:
      properties:
        status:
          description: Change Request status to set.
          enum:
          - cancelled
          - resolving
          type: string
      required:
      - status
      type: object
    ChangeRequestsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of Change Requests
          items:
            $ref: '#/components/schemas/ChangeRequestResponse'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ChannelCreatedByResponse:
      properties:
        firstName:
          description: First Name.
          nullable: true
          type: string
          x-versionadded: v2.33
        lastName:
          description: Last Name.
          nullable: true
          type: string
          x-versionadded: v2.33
        username:
          description: Username.
          type: string
          x-versionadded: v2.33
      required:
      - firstName
      - lastName
      - username
      type: object
    ChannelDREntity:
      properties:
        id:
          description: The id of DataRobot entity.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the entity.
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      type: object
    ClassDistribution:
      properties:
        className:
          description: Name of the class
          type: string
        count:
          description: Count of rows labeled with a class in the bucket
          type: integer
        percent:
          description: Percent of rows labeled with a class in the bucket
          type: number
      required:
      - className
      - count
      - percent
      type: object
    ClassMappingAggregationSettings:
      properties:
        aggregationClassName:
          description: The name of the class that will be assigned to all rows with
            aggregated classes. Should not match any excluded_from_aggregation or
            we will have 2 classes with the same name and no way to distinguish between
            them. This option is only available formulticlass projects. By default
            'DR_RARE_TARGET_VALUES' is used.
          type: string
        excludedFromAggregation:
          default: []
          description: List of target values that should be guaranteed to kept as
            is, regardless of other settings.
          items:
            type: string
          type: array
        maxUnaggregatedClassValues:
          default: 1000
          description: The maximum number of unique labels before aggregation kicks
            in. Should be at least len(excludedFromAggregation) + 1 for multiclass
            and at least len(excludedFromAggregation) for multilabel.
          maximum: 1000
          minimum: 3
          type: integer
        minClassSupport:
          default: 1
          description: Minimum number of instances necessary for each target value
            in the dataset. All values with fewer instances than this value will be
            aggregated
          type: integer
      type: object
    ClassificationBinDataResponse:
      properties:
        binEnd:
          description: The end of the numeric range for the current bin. Note that
            `binEnd` - `binStart` should be a constant, modulo floating-point rounding
            error, for all bins in a single plot.
          type: number
        binStart:
          description: The start of the numeric range for the current bin. Must be
            equal to the `binEnd` of the previous bin.
          type: number
        negatives:
          description: The number of records in the dataset where the model's predicted
            value falls into this bin and the target is negative.
          type: integer
        positives:
          description: The number of records in the dataset where the model's predicted
            value falls into this bin and the target is positive.
          type: integer
      required:
      - binEnd
      - binStart
      - negatives
      - positives
      type: object
    ClusterInfoList:
      properties:
        name:
          description: A cluster name.
          maxLength: 50
          minLength: 1
          type: string
        percent:
          description: The percentage of rows in the dataset this cluster contains.
          maximum: 100
          minimum: 0
          type: number
      required:
      - name
      type: object
    ClusterInsightsPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of features with clusters insights.
          items:
            anyOf:
            - $ref: '#/components/schemas/ImageFeature'
            - $ref: '#/components/schemas/GeospatialFeature'
            - $ref: '#/components/schemas/TextFeature'
            - $ref: '#/components/schemas/NumericFeature'
            - $ref: '#/components/schemas/CategoricalFeature'
            - $ref: '#/components/schemas/DocumentFeature'
          maxItems: 100
          type: array
        isCurrentClusterInsightVersion:
          description: If retrieved insights are current version.
          type: boolean
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
        version:
          description: Current version of the computed insight.
          minimum: 0
          type: integer
      required:
      - data
      - isCurrentClusterInsightVersion
      - next
      - previous
      - totalCount
      - version
      type: object
    ClusterLicenseRetrieveResponse:
      properties:
        licenseInfo:
          $ref: '#/components/schemas/ClusterLicenseRetrieveResponseLicense'
          description: The license info object will describe detailed information
            about the deployed license
        uploadInfo:
          $ref: '#/components/schemas/ClusterLicenseRetrieveResponseUploadInfo'
          description: The upload info object will describe detailed information about
            the user who uploaded the current license
      required:
      - licenseInfo
      - uploadInfo
      type: object
    ClusterLicenseRetrieveResponseLicense:
      properties:
        concurrentWorkersCount:
          description: The number of allowed simultaneously running jobs(concurrent
            workers)
          minimum: 0
          type: integer
        expirationTimestamp:
          description: The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z
          type: string
        expired:
          description: A value indicating whether the license has already expired
          type: boolean
        featureFlags:
          additionalProperties:
            $ref: '#/components/schemas/FeatureFlagObject'
          description: An object containing enforced feature flags. Each key is a
            name of a feature flag and value is an object described below.
          type: object
        maxDeploymentLimit:
          description: 'The number of maximum deployments limit (0: unlimited)'
          minimum: 0
          type: integer
        maximumActiveUsers:
          description: 'The number of maximum active users allowed in the system(0:
            unlimited'
          minimum: 0
          type: integer
        prepaidDeploymentLimit:
          description: 'The number of prepaid deployments limit (0: unlimited)'
          minimum: 0
          type: integer
      required:
      - concurrentWorkersCount
      - expirationTimestamp
      - expired
      - featureFlags
      - maxDeploymentLimit
      - maximumActiveUsers
      - prepaidDeploymentLimit
      type: object
    ClusterLicenseRetrieveResponseUploadInfo:
      properties:
        uploadTimestamp:
          description: the time when the current license was uploaded in UTC ISO format,
            ex. '2020-12-21T23:59:59.000000Z'
          type: string
        uploaderUserId:
          description: Id of the user who uploaded the current license
          type: string
        uploaderUsername:
          description: The username of the user who uploaded the current license
          type: string
      required:
      - uploadTimestamp
      - uploaderUserId
      - uploaderUsername
      type: object
    ClusterLicenseUpdate:
      properties:
        licenseKey:
          description: The license key provided by customer support
          type: string
      required:
      - licenseKey
      type: object
    ClusterLicenseValidationResponse:
      properties:
        licenseInfo:
          $ref: '#/components/schemas/ClusterLicenseRetrieveResponseLicense'
          description: The license info object will describe detailed information
            about the deployed license
      required:
      - licenseInfo
      type: object
    ClusterNamesMappingValidation:
      properties:
        currentName:
          description: Current cluster name.
          maxLength: 50
          minLength: 1
          type: string
        newName:
          description: New cluster name.
          maxLength: 50
          minLength: 1
          type: string
      required:
      - currentName
      - newName
      type: object
    ClusterNamesResponse:
      properties:
        clusters:
          description: A list of the model's cluster information entries.
          items:
            $ref: '#/components/schemas/ClusterInfoList'
          maxItems: 100
          minItems: 2
          type: array
        modelId:
          description: The model ID
          type: string
        projectId:
          description: The project ID
          type: string
      required:
      - clusters
      - modelId
      - projectId
      type: object
    ClusterNamesUpdateParam:
      properties:
        clusterNameMappings:
          description: "\n            A list of the mappings from a cluster's current\
            \ name to its new name.\n            After update, value passed as a new\
            \ name will become cluster's current name.\n            All cluster names\
            \ should be unique and should identify one and only one cluster.\n   \
            \         "
          items:
            $ref: '#/components/schemas/ClusterNamesMappingValidation'
          maxItems: 100
          type: array
      required:
      - clusterNameMappings
      type: object
    ColnameAndType:
      properties:
        colname:
          description: The column name.
          type: string
        hex:
          description: A safe hex representation of the column name.
          type: string
        type:
          description: The data type of the column.
          type: string
      required:
      - colname
      - hex
      - type
      type: object
    CombinedModelListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of combined models.
          items:
            $ref: '#/components/schemas/CommonGetAndListCombinedModel'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CombinedModelResponse:
      properties:
        combinedModelId:
          description: The ID of combined model.
          type: string
        isActiveCombinedModel:
          default: false
          description: Indicates whether this model is the active one in segmented
            modeling project.
          type: boolean
          x-versionadded: v2.29
        modelCategory:
          description: Indicates what kind of model this is. Will be ``combined``
            for combined models.
          enum:
          - combined
          type: string
        projectId:
          description: The ID of the project.
          type: string
        segmentationTaskId:
          description: The ID of the segmentation task used to generate this combined
            model.
          type: string
        segments:
          description: Information for each segment. Maps each segment to the project
            and model used for it.
          items:
            $ref: '#/components/schemas/SegmentProjectModelResponse'
          type: array
      required:
      - combinedModelId
      - isActiveCombinedModel
      - modelCategory
      - projectId
      - segmentationTaskId
      - segments
      type: object
    CombinedModelSegmentsPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of combined model segments info.
          items:
            $ref: '#/components/schemas/CombinedModelSegmentsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CombinedModelSegmentsResponse:
      properties:
        autopilotDone:
          description: Is autopilot done for the project.
          nullable: true
          type: boolean
        holdoutUnlocked:
          description: Is holdout unlocked for the project.
          nullable: true
          type: boolean
        isFrozen:
          description: Indicates whether the segment champion model is frozen, i.e.
            uses tuning parameters from a parent model
          nullable: true
          type: boolean
        modelAssignedBy:
          description: Who assigned model as segment champion. Default is ``DataRobot``.
          nullable: true
          type: string
        modelAwardTime:
          description: Time when model was awarded as segment champion.
          format: date-time
          nullable: true
          type: string
        modelCount:
          description: Count of trained models in project.
          nullable: true
          type: integer
        modelIcon:
          description: The number for the icon representing the given champion model.
          items:
            type: integer
          nullable: true
          type: array
        modelId:
          description: ID of segment champion model.
          nullable: true
          type: string
        modelMetrics:
          description: The performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or ``null`` if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          nullable: true
          type: object
        modelType:
          description: The description of the model type of the given champion model.
          nullable: true
          type: string
        projectId:
          description: The ID of the project.
          nullable: true
          type: string
        projectPaused:
          description: Is project paused right now.
          nullable: true
          type: boolean
        projectStage:
          description: The current stage of the project, where modeling indicates
            that the target has been successfully set and modeling and predictions
            may proceed.
          enum:
          - modeling
          - aim
          - fasteda
          - eda
          - eda2
          - empty
          nullable: true
          type: string
        projectStageDescription:
          description: A description of the current stage of the project.
          nullable: true
          type: string
        projectStatusError:
          description: Project status error message.
          nullable: true
          type: string
        rowCount:
          description: Count of rows in project's dataset.
          nullable: true
          type: integer
        rowPercentage:
          description: Percentage of rows in segment project's dataset comparing to
            original dataset.
          nullable: true
          type: number
        segment:
          description: Segment name.
          type: string
      required:
      - autopilotDone
      - holdoutUnlocked
      - isFrozen
      - modelAssignedBy
      - modelAwardTime
      - modelCount
      - modelIcon
      - modelId
      - modelMetrics
      - modelType
      - projectId
      - projectStage
      - projectStageDescription
      - rowCount
      - rowPercentage
      - segment
      type: object
    Comment:
      properties:
        content:
          description: Content of the comment, 10000 symbols max
          maxLength: 10000
          type: string
        entityId:
          description: ID of the entity to post the comment to
          type: string
        entityType:
          description: Type of the entity to post the comment to, currently only useCase
            is supported
          enum:
          - useCase
          - model
          - catalog
          type: string
        mentions:
          description: A list of users IDs mentioned in the content
          items:
            type: string
          maxItems: 100
          type: array
      required:
      - content
      - entityId
      - entityType
      type: object
    CommentList:
      properties:
        count:
          description: Number of items returned on this page
          type: integer
        data:
          description: A list of comments
          items:
            $ref: '#/components/schemas/CommentRetrieve'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: Number of all available items
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    CommentRetrieve:
      properties:
        content:
          description: Content of the comment
          type: string
        createdAt:
          description: Timestamp when the comment was created
          type: string
        createdBy:
          $ref: '#/components/schemas/CommentUser'
          description: 'User object with information about the comment author '
        entityId:
          description: ID of the entity the comment posted to
          type: string
        entityType:
          description: Type of the entity to post the comment to, currently only useCase
            is supported
          enum:
          - useCase
          - model
          - catalog
          type: string
        id:
          description: ID of the comment
          type: string
        mentions:
          description: A list of users objects (see below) mentioned in the content
          items:
            $ref: '#/components/schemas/CommentUser'
          type: array
        updatedAt:
          description: Timestamp when the comment was updated
          type: string
      required:
      - content
      - createdAt
      - createdBy
      - entityId
      - entityType
      - id
      - mentions
      - updatedAt
      type: object
    CommentUpdate:
      properties:
        content:
          description: Updated content of the comment, 10000 symbols max
          maxLength: 10000
          type: string
        mentions:
          description: A list of users IDs mentioned in the content
          items:
            type: string
          maxItems: 100
          type: array
      required:
      - content
      type: object
    CommentUser:
      properties:
        firstName:
          description: First name of the commenter
          type: string
        id:
          description: User ID of the commenter
          type: string
        lastName:
          description: Last name of the commenter
          type: string
        username:
          description: Username of the commenter
          type: string
      required:
      - firstName
      - id
      - lastName
      - username
      type: object
    CommonGetAndListCombinedModel:
      properties:
        combinedModelId:
          description: The ID of combined model.
          type: string
        isActiveCombinedModel:
          default: false
          description: Indicates whether this model is the active one in segmented
            modeling project.
          type: boolean
          x-versionadded: v2.29
        modelCategory:
          description: Indicates what kind of model this is. Will be ``combined``
            for combined models.
          enum:
          - combined
          type: string
        projectId:
          description: The ID of the project.
          type: string
        segmentationTaskId:
          description: The ID of the segmentation task used to generate this combined
            model.
          type: string
      required:
      - combinedModelId
      - isActiveCombinedModel
      - modelCategory
      - projectId
      - segmentationTaskId
      type: object
    ComplianceDocTemplateCreate:
      properties:
        labels:
          description: Names of the labels to assign to the template.
          items:
            type: string
          type: array
          x-versionadded: v2.22
        name:
          description: Name of the new template. Must be unique among templates created
            by the user.
          type: string
        projectType:
          description: Type of project template.
          enum:
          - autoMl
          - timeSeries
          type: string
          x-versionadded: v2.22
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, i.e., the structure is recursive. The number of
            nested sections allowed is 5. The total number of sections allowed is
            500. '
          items:
            oneOf:
            - $ref: '#/components/schemas/SectionDataRobot'
            - $ref: '#/components/schemas/SectionUser'
            - $ref: '#/components/schemas/SectionCustom'
            - $ref: '#/components/schemas/SectionTableOfContents'
          type: array
      required:
      - name
      - sections
      type: object
    ComplianceDocTemplateCreateResponse:
      properties:
        dateModified:
          description: Timestamp of the created template
          format: date-time
          type: string
        id:
          description: Created template Id
          type: string
      required:
      - dateModified
      - id
      type: object
    ComplianceDocTemplateDefaultRetrieveResponse:
      properties:
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, i.e., the structure is recursive. The number of
            nested sections allowed is 5. The total number of sections allowed is
            500. '
          items:
            oneOf:
            - $ref: '#/components/schemas/SectionDataRobot'
            - $ref: '#/components/schemas/SectionUser'
            - $ref: '#/components/schemas/SectionCustom'
            - $ref: '#/components/schemas/SectionTableOfContents'
          type: array
      required:
      - sections
      type: object
    ComplianceDocTemplateListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of templates.
          items:
            $ref: '#/components/schemas/TemplateResponse'
          type: array
        next:
          description: URL pointing to the previous page. If null, there is no next
            page.
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page. If null, there is no previous
            page.
          format: uri
          nullable: true
          type: string
        totalCount:
          description: Total number of templates.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ComplianceDocTemplateUpdate:
      properties:
        description:
          description: New description for the template.
          type: string
        labels:
          description: Names of the labels to assign to the template.
          items:
            type: string
          type: array
          x-versionadded: v2.22
        name:
          description: New name for the template. Must be unique among templates created
            by the user.
          type: string
        projectType:
          description: Type of project template.
          enum:
          - autoMl
          - timeSeries
          type: string
          x-versionadded: v2.22
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, i.e., the structure is recursive. The number of
            nested sections allowed is 5. The total number of sections allowed is
            500. '
          items:
            oneOf:
            - $ref: '#/components/schemas/SectionDataRobot'
            - $ref: '#/components/schemas/SectionUser'
            - $ref: '#/components/schemas/SectionCustom'
            - $ref: '#/components/schemas/SectionTableOfContents'
          type: array
      type: object
    ComputeFeatureEffectsRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
        entityId:
          description: ID of the entity.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - training
          - backtest_0
          - backtest_1
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          - holdout
          - backtest_0_training
          - backtest_1_training
          - backtest_2_training
          - backtest_3_training
          - backtest_4_training
          - backtest_5_training
          - backtest_6_training
          - backtest_7_training
          - backtest_8_training
          - backtest_9_training
          - backtest_10_training
          - backtest_11_training
          - backtest_12_training
          - backtest_13_training
          - backtest_14_training
          - backtest_15_training
          - backtest_16_training
          - backtest_17_training
          - backtest_18_training
          - backtest_19_training
          - backtest_20_training
          - holdout_training
          type: string
      required:
      - entityId
      - source
      type: object
    ComputeFeatureImpactRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
        entityId:
          description: ID of the entity.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          type: string
        rowCount:
          description: Number of rows to use to calculate feature impact.
          maximum: 100000
          minimum: 10
          type: integer
        source:
          default: training
          description: The subset of data used to compute the insight.
          enum:
          - training
          - backtest_2_training
          - backtest_3_training
          - backtest_4_training
          - backtest_5_training
          - backtest_6_training
          - backtest_7_training
          - backtest_8_training
          - backtest_9_training
          - backtest_10_training
          - backtest_11_training
          - backtest_12_training
          - backtest_13_training
          - backtest_14_training
          - backtest_15_training
          - backtest_16_training
          - backtest_17_training
          - backtest_18_training
          - backtest_19_training
          - backtest_20_training
          - backtest_1_training
          - holdout_training
          type: string
      required:
      - entityId
      - rowCount
      - source
      type: object
    ComputeInsightsResponse:
      properties:
        qid:
          description: The QID of the job that computes insights request.
          nullable: true
          type: integer
      required:
      - qid
      type: object
    ComputeLiftChartRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
        entityId:
          description: ID of the entity.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
      required:
      - entityId
      - source
      type: object
    ComputeNewDirectiveArguments:
      properties:
        expression:
          description: The expression for new feature computation.
          type: string
          x-versionadded: v2.33
        newFeatureName:
          description: The new feature name which will hold results of expression
            evaluation.
          type: string
          x-versionadded: v2.33
      required:
      - expression
      - newFeatureName
      type: object
    ComputeResidualsRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
        entityId:
          description: ID of the entity.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      required:
      - entityId
      - source
      type: object
    ComputeRocCurveRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
        entityId:
          description: ID of the entity.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
      required:
      - entityId
      - source
      type: object
    ComputeShapImpactRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
          x-versionadded: v2.33
        entityId:
          description: ID of the entity.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: ID of the external dataset
          type: string
          x-versionadded: v2.33
        rowCount:
          description: Number of rows to use to calculate SHAP impact.
          type: integer
          x-versionadded: v2.33
        source:
          description: The subset of data used to compute the insight.
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
          x-versionadded: v2.33
      required:
      - entityId
      - rowCount
      - source
      type: object
    ComputeShapMatrixRequest:
      properties:
        dataSliceId:
          description: ID of the Data Slice
          type: string
          x-versionadded: v2.33
        entityId:
          description: ID of the entity.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: ID of the external dataset
          type: string
          x-versionadded: v2.33
        source:
          description: The subset of data used to compute the insight.
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
          x-versionadded: v2.33
      required:
      - entityId
      - source
      type: object
    ConfusionChartClassMatrix:
      properties:
        actualCount:
          description: number of times this class is seen in the validation data
          type: integer
        className:
          description: name of the class
          type: string
        confusionMatrixOneVsAll:
          description: '2d array representing 2x2 one vs all matrix. This represents
            the True/False Negative/Positive rates as integer for each class. The
            data structure looks like: ``[ [ True Negative, False Positive ], [ False
            Negative, True Positive ] ]``'
          items:
            items:
              type: integer
            type: array
          type: array
        f1:
          description: F1 score
          type: number
        precision:
          description: precision score
          type: number
        predictedCount:
          description: number of times this class has been predicted for the validation
            data
          type: integer
        recall:
          description: recall score
          type: number
        wasActualPercentages:
          description: one vs all actual percentages in a format specified below
          items:
            $ref: '#/components/schemas/ActualPercentages'
          type: array
        wasPredictedPercentages:
          description: one vs all predicted percentages in a format specified below
          items:
            $ref: '#/components/schemas/PredictedPercentages'
          type: array
      required:
      - actualCount
      - className
      - confusionMatrixOneVsAll
      - f1
      - precision
      - predictedCount
      - recall
      - wasActualPercentages
      - wasPredictedPercentages
      type: object
    ConfusionChartData:
      properties:
        classMetrics:
          description: per-class information including one vs all scores in a format
            specified below
          items:
            $ref: '#/components/schemas/ConfusionChartClassMatrix'
          type: array
        classes:
          description: class labels from the dataset, union of row classes & column
            classes. This field is deprecated as of v2.13. The rows and columns may
            have different class labels when using query parameters to retrieve a
            slice of the matrix; please use 'rowClasses' and 'colClasses' instead.
          items:
            type: string
          type: array
        colClasses:
          description: class labels on columns of confusion matrix
          items:
            type: string
          type: array
        confusionMatrix:
          description: 2d array of ints representing confusion matrix, aligned with
            `rowClasses` and 'colClasses'array. For confusionMatrix[A][B] we can get
            an integer that represents the number of times 'if class with index A
            was correct we have class with index B predicted' (if the orientation
            is 'actual').
          items:
            items:
              type: integer
            type: array
          type: array
        rowClasses:
          description: class labels on rows of confusion matrix
          items:
            type: string
          type: array
      required:
      - classMetrics
      - classes
      - colClasses
      - confusionMatrix
      - rowClasses
      type: object
    ConfusionChartForDatasetsListResponse:
      properties:
        count:
          description: Number of results returned on this page.
          type: integer
        data:
          description: Confusion chart data with the in the same format as the response
            from :http:get:`/api/v2/projects/(projectId)/models/(modelId)/confusionCharts/(source)/`
            with additional totalCount field.
          items:
            $ref: '#/components/schemas/ModelConfusionChartRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: Total count of confusion charts for model.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ConfusionChartRetrieveForDatasets:
      properties:
        columns:
          description: '[colStart, colEnd] column dimension of confusion matrix in
            response'
          items:
            type: integer
          type: array
        data:
          $ref: '#/components/schemas/ConfusionChartData'
          description: 'confusion chart data with the format below. '
        datasetId:
          description: The datasetId to retrieve a Confusion chart from.
          type: string
        numberOfClasses:
          description: count of classes in full confusion matrix.
          type: integer
        rows:
          description: '[rowStart, rowEnd] row dimension of confusion matrix in response'
          items:
            type: integer
          type: array
        totalMatrixSum:
          description: sum of all values in full confusion matrix
          type: integer
      required:
      - columns
      - data
      - datasetId
      - numberOfClasses
      - rows
      - totalMatrixSum
      type: object
    ConfusionChartRetrieveMetadataForDatasets:
      properties:
        classNames:
          description: list of all class names in the full confusion matrix, sorted
            by the `orderBy` parameter.
          items:
            type: string
          type: array
        datasetId:
          description: The dataset to retrieve a Confusion chart from.
          type: string
        modelId:
          description: The model to retrieve a Confusion chart from.
          type: string
        projectId:
          description: The project to retrieve a Confusion chart from.
          type: string
        relevantClassesPositions:
          description: Matrix to highlight important cell blocks in the confusion
            chart. Intended to represent a thumbnail view, where the relevantClassesPositions
            array has a 1 in thumbnail cells that are of interest, and 0 otherwise.
            The dimensions of the implied thumbnail will not match those of the confusion
            matrix, e.g. a twenty-class confusion matrix may have a 2x2 thumbnail.
          items:
            items:
              type: integer
            type: array
          type: array
        totalMatrixSum:
          description: Sum of all values in the full confusion matrix (equal to the
            number of points considered).
          type: integer
      required:
      - classNames
      - datasetId
      - modelId
      - projectId
      - relevantClassesPositions
      - totalMatrixSum
      type: object
    ConnectorFieldSchema:
      properties:
        choices:
          description: If non-empty, a list of all possible values for a parameter.
          items:
            type: string
          type: array
        default:
          description: Default value of the parameter.
          type: string
        description:
          description: Description of the parameter.
          type: string
        name:
          description: Name of the parameter.
          type: string
        required:
          description: Whether or not the parameter is required for a connection.
          type: boolean
        visibleByDefault:
          description: Whether or not the parameter should be shown in the UI by default.
          type: boolean
      required:
      - choices
      - default
      - description
      - name
      - required
      - visibleByDefault
      type: object
    Constraints:
      properties:
        ascii:
          $ref: '#/components/schemas/BaseConstraintType'
          description: Indicates that the value can contain free-form ASCII text.
            If present, is an empty object. Note that `ascii` fields must be valid
            ASCII-encoded strings. Additionally, they may not contain semicolons or
            newlines.
        float:
          $ref: '#/components/schemas/Float'
          description: Numeric constraints on a floating-point value. If present,
            indicates that this parameter's value may be a JSON number (integer or
            floating point).
        floatList:
          $ref: '#/components/schemas/FloatList'
          description: Numeric constraints on a value of an array of floating-point
            numbers. If present, indicates that this parameter's value may be a JSON
            array of numbers (integer or floating point).
        int:
          $ref: '#/components/schemas/Int'
          description: Numeric constraints on an integer value. If present, indicates
            that this parameter's value may be a JSON integer.
        intList:
          $ref: '#/components/schemas/IntList'
          description: Numeric constraints on a value of an array of floating-point
            numbers. If present, indicates that this parameter's value may be a JSON
            array of integers.
        select:
          $ref: '#/components/schemas/Select'
          description: Indicates that the value can be one selected from a list of
            known values.
        selectgrid:
          $ref: '#/components/schemas/Select'
          description: Indicates that the value can be many selected from a list of
            known values.
          x-versionadded: v2.19
        unicode:
          $ref: '#/components/schemas/BaseConstraintType'
          description: Indicates that the value can contain free-form Unicode text.
            If present, is an empty object. Any valid JSON string is permitted as
            input. Note that DataRobot expects all Unicode JSON input to be encoded
            using UTF-8.
      type: object
    ConversionCreateQuery:
      properties:
        mainProgramItemId:
          description: The main program file item ID.
          type: string
          x-versionadded: v2.26
      required:
      - mainProgramItemId
      type: object
    ConversionListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom model conversions.
          items:
            $ref: '#/components/schemas/ConversionResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ConversionResponse:
      properties:
        conversionInProgress:
          description: Whether a custom model conversion is in progress or not.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        conversionSucceeded:
          description: Indication for a successful custom model conversion.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        created:
          description: ISO-8601 timestamp of when the custom model conversion created.
          type: string
        customModelVersionId:
          description: ID of the custom model version.
          type: string
        generatedMetadata:
          $ref: '#/components/schemas/GeneratedMetadata'
          description: Custom model conversion output metadata.
          nullable: true
          x-versionadded: v2.26
        id:
          description: ID of the custom model version.
          type: string
        logMessage:
          description: The output log message from the custom model conversion process.
          nullable: true
          type: string
          x-versionadded: v2.26
        mainProgramItemId:
          description: The main program file item ID.
          nullable: true
          type: string
          x-versionadded: v2.26
        shouldStop:
          default: false
          description: Whether the user requested to stop the given conversion.
          type: boolean
          x-versionadded: v2.26
      required:
      - created
      - customModelVersionId
      - id
      type: object
    CreateCredentialsResponse:
      properties:
        creationDate:
          description: ISO-8601 formatted date/time when these credentials were created.
          format: date-time
          type: string
        credentialId:
          description: ID of these credentials.
          type: string
        credentialType:
          default: basic
          description: Type of credentials.
          enum:
          - adls_gen2_oauth
          - api_token
          - azure
          - azure_service_principal
          - basic
          - bearer
          - databricks_access_token_account
          - databricks_service_principal_account
          - gcp
          - oauth
          - rsa
          - s3
          - snowflake_key_pair_user_account
          - snowflake_oauth_user_account
          - tableau_access_token
          type: string
        description:
          description: Description of these credentials.
          type: string
        name:
          description: Name of these credentials.
          type: string
      required:
      - creationDate
      - credentialId
      - name
      type: object
    CreateCustomJob:
      properties:
        description:
          description: The description of the custom job.
          maxLength: 10000
          type: string
          x-versionadded: v2.33
        environmentId:
          description: The ID of the execution environment to use for this custom
            job.
          type: string
          x-versionadded: v2.33
        environmentVersionId:
          description: The ID of the execution environment version to use for this
            custom job. If not provided, the latest execution environment version
            will be used.
          type: string
          x-versionadded: v2.33
        file:
          description: 'A file with code for a custom task or a custom model. For
            each file supplied as form data, you must have a corresponding `filePath`
            supplied that shows the relative location of the file. For example, you
            have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`.
            When uploading these files, you would _also_ need to include two `filePath`
            fields of, `"main.py"` and `"helpers/helper.py"`. If the supplied `file`
            already exists at the supplied `filePath`, the old file is replaced by
            the new file.'
          format: binary
          type: string
          x-versionadded: v2.33
        filePath:
          description: The local path of the file being uploaded. See the `file` field
            explanation for more details.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
          x-versionadded: v2.33
        jobType:
          default: default
          description: Type of the custom job.
          enum:
          - default
          - hostedCustomMetric
          - notification
          - retraining
          type: string
          x-versionadded: v2.33
        name:
          description: Name of the custom job.
          maxLength: 255
          type: string
          x-versionadded: v2.33
        resources:
          $ref: '#/components/schemas/CustomJobResources'
          description: The custom job resources that will be applied in the k8s cluster.
          nullable: true
          x-versionadded: v2.33
        runtimeParameterValues:
          description: Ability to inject values into a custom job at runtime. The
            fieldName must match a fieldName that is listed in the runtimeParameterDefinitions
            section of the metadata.yaml file. This list will be merged with any existing
            runtime values set from the prior version when issuing a PATCH request
            so it is possible to specify a `null` value to unset specific parameters
            and fall back to the defaultValue from the definition.
          type: string
          x-versionadded: v2.33
      required:
      - name
      type: object
    CreateCustomJobRun:
      properties:
        description:
          description: The description of the custom job run.
          maxLength: 10000
          type: string
          x-versionadded: v2.33
        runtimeParameterValues:
          description: Ability to inject values at runtime. The fieldName must match
            a fieldName that is listed in the runtimeParameterDefinitions section
            of the custom job metadata.yaml file. It has a priority over an existing
            runtime parameter overrides defined at the custom job level.
          items:
            $ref: '#/components/schemas/RuntimeParameterValue'
          type: array
          x-versionadded: v2.33
      type: object
    CreateDataEngineQueryGenerator:
      properties:
        datasets:
          description: Source datasets in the Data Engine workspace.
          items:
            $ref: '#/components/schemas/DataEngineDataset'
          maxItems: 32
          type: array
        generatorSettings:
          $ref: '#/components/schemas/GeneratorSettings'
          description: Data engine generator settings of the given `generator_type`.
        generatorType:
          description: Type of data engine query generator
          enum:
          - TimeSeries
          type: string
      required:
      - datasets
      - generatorSettings
      - generatorType
      type: object
    CreateDriverRequest:
      properties:
        baseNames:
          description: Original file name(s) of the uploaded JAR file(s). If there
            are multiple JAR files required for the driver, each of the original file
            names should be present in the list in the same order as found in 'localJarUrls'
          items:
            description: Original file name of the uploaded JAR file.
            type: string
          type: array
        canonicalName:
          description: User-friendly driver name.
          type: string
        className:
          description: Driver class name. For example 'com.amazon.redshift.jdbc.Driver'
          nullable: true
          type: string
        configurationId:
          description: Driver configuration ID if it was provided during driver upload.
          nullable: true
          type: string
          x-versionadded: v2.18
        databaseDriver:
          description: The type of database of the driver. Only required of 'dr-database-v1'
            drivers.
          enum:
          - bigquery-v1
          - databricks-v1
          nullable: true
          type: string
          x-versionadded: v2.30
        localJarUrls:
          description: File path(s) for the driver files.This path is returned in
            the response as 'local_url' by the driverUpload route.If there are multiple
            JAR files required for the driver, each uploaded JAR must be present in
            this list. If specified, values will replace any previous settings.
          items:
            description: File path for the driver file. This path is returned by the
              driverUpload route in the 'local_url' response.
            type: string
          minItems: 1
          type: array
        type:
          default: jdbc
          description: Driver type. Either 'jdbc' or 'dr-database-v1'.
          enum:
          - dr-database-v1
          - jdbc
          type: string
          x-versionadded: v2.30
        version:
          description: Driver version, which is used to construct the canonical name
            if driver configuration ID was provided during driver upload.
          type: string
          x-versionadded: v2.18
      type: object
    CreateFeaturelist:
      properties:
        features:
          description: List of features for new featurelist.
          items:
            type: string
          minItems: 1
          type: array
        name:
          description: New featurelist name.
          maxLength: 100
          type: string
        skipDatetimePartitionColumn:
          default: false
          description: Whether featurelist should contain datetime partition column.
          type: boolean
          x-versionadded: v2.24
      required:
      - features
      - name
      type: object
    CreateFromRecipe:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
          x-versionadded: v2.33
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          x-versionadded: v2.33
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
          type: string
          x-versionadded: v2.33
        doSnapshot:
          default: true
          description: If true, create a snapshot dataset; if false, create a remote
            dataset. Creating snapshots from non-file sources requires an additional
            permission, `Enable Create Snapshot Data Source`.
          type: boolean
          x-versionadded: v2.33
        materializationDestination:
          $ref: '#/components/schemas/MaterializationDestination'
          default: null
          description: Destination table information to create and materialize the
            recipe to. If None, the recipe will be materialized in DataRobot.
          nullable: true
          x-versionadded: v2.33
        name:
          description: Name to be assigned to new Dataset.
          type: string
          x-versionadded: v2.33
        persistDataAfterIngestion:
          default: true
          description: If true, will enforce saving all data (for download and sampling)
            and will allow a user to view extended data profile (which includes data
            statistics like min/max/median/mean, histogram, etc.). If false, will
            not enforce saving data. The data schema (feature names and types) still
            will be available. Specifying this parameter to false and `doSnapshot`
            to true will result in an error.
          type: boolean
          x-versionadded: v2.33
        recipeId:
          description: The identifier for the Wrangling Recipe to use as the source
            of data.
          type: string
          x-versionadded: v2.33
        useKerberos:
          default: false
          description: If true, use kerberos authentication for database authentication.
          type: boolean
          x-versionadded: v2.33
      required:
      - recipeId
      type: object
    CreatePredictionDatasetResponse:
      properties:
        datasetId:
          description: The ID of the newly created prediction dataset.
          type: string
      required:
      - datasetId
      type: object
    CreatePredictionFromDataset:
      properties:
        actualValueColumn:
          description: For time series projects only. Actual value column name, valid
            for the prediction files if the project is unsupervised and the dataset
            is considered as bulk predictions dataset. This value is optional.
          type: string
          x-versionadded: v2.21
        datasetId:
          description: The dataset to compute predictions for - must have previously
            been uploaded.
          type: string
        explanationAlgorithm:
          description: If set to `shap`, the response will include prediction explanations
            based on the SHAP explainer (SHapley Additive exPlanations). Defaults
            to null (no prediction explanations).
          enum:
          - shap
          type: string
        forecastPoint:
          description: For time series projects only. The time in the dataset relative
            to which predictions are generated. This value is optional. If not specified
            the default value is the value in the row with the latest specified timestamp.
            Specifying this value for a project that is not a time series project
            will result in an error.
          format: date-time
          type: string
          x-versionadded: v2.20
        includeFdwCounts:
          default: false
          description: For time series projects with partial history only. Indicates
            if feature derivation window counts `featureDerivationWindowCounts` will
            be part of the response.
          type: boolean
          x-versionadded: v2.24
        includePredictionIntervals:
          description: Specifies whether prediction intervals should be calculated
            for this request. Defaults to True if `predictionIntervalsSize` is specified,
            otherwise defaults to False.
          type: boolean
          x-versionadded: v2.16
        maxExplanations:
          description: 'Specifies the maximum number of explanation values that should
            be returned for each row, ordered by absolute value, greatest to least.
            In the case of ''shap'': If not set, explanations are returned for all
            features. If the number of features is greater than the ''maxExplanations'',
            the sum of remaining values will also be returned as ''shapRemainingTotal''.
            Defaults to null for datasets narrower than 100 columns, defaults to 100
            for datasets wider than 100 columns. Cannot be set if ''explanationAlgorithm''
            is omitted.'
          maximum: 100
          minimum: 1
          type: integer
          x-versionadded: v2.21
        modelId:
          description: The model to make predictions on.
          type: string
        predictionIntervalsSize:
          description: Represents the percentile to use for the size of the prediction
            intervals. Defaults to 80 if `includePredictionIntervals` is True.
          maximum: 100
          minimum: 1
          type: integer
          x-versionadded: v2.16
        predictionThreshold:
          description: Threshold used for binary classification in predictions. Accepts
            values from 0.0 to 1.0. If not specified, model default prediction threshold
            will be used.
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.22
        predictionsEndDate:
          description: The end date for bulk predictions, exclusive. Used for time
            series projects only. Note that this parameter is used for generating
            historical predictions using the training data, not for future predictions.
            If not specified, the dataset is not considered as a bulk predictions
            dataset. This parameter should be provided in conjunction with a ``predictionsStartDate``,
            and cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
          x-versionadded: v2.20
        predictionsStartDate:
          description: The start date for bulk predictions. Used for time series projects
            only. Note that this parameter is used for generating historical predictions
            using the training data, not for future predictions. If not specified,
            the dataset is not considered as a bulk predictions dataset. This parameter
            should be provided in conjunction with a ``predictionsEndDate``, and cannot
            be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
          x-versionadded: v2.20
      required:
      - datasetId
      - modelId
      type: object
    CreateRatingTableModel:
      properties:
        ratingTableId:
          description: the rating table ID to use to create a new model
          type: string
      required:
      - ratingTableId
      type: object
    CreateRemoteEventResponse:
      properties:
        message:
          description: The descriptive message about the event creation.
          type: string
      required:
      - message
      type: object
    CreateShapMatrixPayload:
      properties:
        datasetId:
          description: The dataset ID.
          type: string
        modelId:
          description: The model ID.
          type: string
      required:
      - datasetId
      - modelId
      type: object
    CreateSsoConfiguration:
      properties:
        attributeMapping:
          $ref: '#/components/schemas/EnhancedSamlAttributeMapping'
          description: Attribute mapping between Datarobot and IdP.
        autoGenerateUsers:
          description: Determines if DataRobot automatically creates an account on
            first successful login via IdP if the user doesn't exist in the DataRobot
            application.
          type: boolean
        certificate:
          $ref: '#/components/schemas/SamlCertificate'
          description: certificate to be used by IdP.
        configurationType:
          description: "The type of the SSO configuration, defines the source of SSO\
            \ metadata.\n            It can be one of the following: `METADATA` -\
            \ when IDP metadata is provided in the\n            config, `METADATA_URL`\
            \ - when an URL for metadata retrieval is provided in the config and\n\
            \            `MANUAL` - when IDP sign-on/sign-out URLs and certificate\
            \ are provided."
          enum:
          - MANUAL
          - METADATA
          - METADATA_URL
          type: string
        enableSso:
          description: Defines if SSO is enabled.
          type: boolean
        enforceSso:
          description: Defines if SSO is enforced.
          type: boolean
        entityId:
          description: The globally unique identifier of the entity. Provided by IdP
            service.
          type: string
        groupMapping:
          description: The list of DataRobot group to identity provider group maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlGroupMapping'
          type: array
        idpMetadata:
          $ref: '#/components/schemas/SamlMetadataFile'
          description: XML document, IdP SSO descriptor. Provided by IdP service.
        idpMetadataHttpsVerify:
          description: "When idp_metadata_url uses HTTPS, require the server to have\
            \ a trusted certificate.\n            To avoid security vulnerabilities,\
            \ only set to False when a trusted server has a\n            self-signed\
            \ certificate."
          type: boolean
        idpMetadataUrl:
          description: URL to the IdP SSO descriptor. Provided by IdP service.
          format: uri
          type: string
        idpResponseMethod:
          default: POST
          description: Identity provider response method, used to move user from IdP's
            authentication form back to the DataRobot side.
          enum:
          - POST
          - REDIRECT
          type: string
        issuer:
          description: Optional Issuer field that may be required by IdP.
          type: string
        name:
          description: The name of the SSO configuration.
          type: string
        organizationId:
          description: The organization ID to which the SSO config belongs.
          type: string
        roleMapping:
          description: The list of DataRobot access role to identity provider role
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlRoleMapping'
          type: array
        securityParameters:
          $ref: '#/components/schemas/SamlSecurityParameters'
          description: The object that contains SAML specific directives.
        sessionLengthSeconds:
          default: 604800
          description: Time window for the authentication session via IDP
          exclusiveMinimum: true
          minimum: 0
          type: integer
        signOnUrl:
          description: URL to sign on via SSO.
          format: uri
          type: string
        signOutUrl:
          description: URL to sign out via SSO.
          format: uri
          type: string
        spRequestMethod:
          default: REDIRECT
          description: Service provider (DataRobot application) request method, is
            used to move user to the IdP's authentication form.
          enum:
          - POST
          - REDIRECT
          type: string
      required:
      - configurationType
      - enableSso
      - enforceSso
      - entityId
      - idpResponseMethod
      - name
      - sessionLengthSeconds
      - spRequestMethod
      type: object
    CreateTrainingPrediction:
      properties:
        dataSubset:
          default: all
          description: 'Subset of data predicted on: The value "all" returns predictions
            for all rows in the dataset including data used for training, validation,
            holdout and any rows discarded. This is not available for large datasets
            or projects created with Date/Time partitioning. The value "validationAndHoldout"
            returns predictions for the rows used to calculate the validation score
            and the holdout score. Not available for large projects or Date/Time projects
            for models trained into the validation set. The value "holdout" returns
            predictions for the rows used to calculate the holdout score. Not available
            for projects created without a holdout or for models trained into holdout
            for large datasets or created with Date/Time partitioning. The value "allBacktests"
            returns predictions for the rows used to calculate the backtesting scores
            for Date/Time projects. The value "validation" returns predictions for
            the rows used to calculate the validation score.'
          enum:
          - all
          - validationAndHoldout
          - holdout
          - allBacktests
          - validation
          - crossValidation
          type: string
          x-enum-versionadded:
          - value: validation
            x-versionadded: v2.21
        explanationAlgorithm:
          description: If set to "shap", the response will include prediction explanations
            based on the SHAP explainer (SHapley Additive exPlanations). Defaults
            to null (no prediction explanations)
          type: string
          x-versionadded: v2.21
        maxExplanations:
          description: 'Specifies the maximum number of explanation values that should
            be returned for each row, ordered by absolute value, greatest to least.
            In the case of "shap": If not set, explanations are returned for all features.
            If the number of features is greater than the "maxExplanations", the sum
            of remaining values will also be returned as "shapRemainingTotal". Defaults
            to null for datasets narrower than 100 columns, defaults to 100 for datasets
            wider than 100 columns. Cannot be set if "explanationAlgorithm" is omitted.'
          maximum: 100
          minimum: 1
          type: integer
          x-versionadded: v2.21
        modelId:
          description: The model to make predictions on
          type: string
      required:
      - dataSubset
      - modelId
      type: object
    CreateValueTrackerAttachment:
      properties:
        attachedObjects:
          description: An array of attachment objects
          items:
            $ref: '#/components/schemas/ValueTrackerAttachment'
          type: array
      required:
      - attachedObjects
      type: object
    CreateWorkspaceState:
      properties:
        datasets:
          description: Source datasets in the Data Engine workspace.
          items:
            $ref: '#/components/schemas/DataEngineDataset'
          type: array
        language:
          description: Language of the Data Engine query.
          enum:
          - SQL
          type: string
        query:
          description: Actual body of the Data Engine query.
          maxLength: 64000
          type: string
      required:
      - language
      - query
      type: object
    CreateWorkspaceStateFromQueryGenerator:
      properties:
        datasetId:
          description: The ID of the dataset.
          type: string
        datasetVersionId:
          description: The ID of the dataset version.
          type: string
        queryGeneratorId:
          description: The ID of the query generator.
          type: string
      required:
      - queryGeneratorId
      type: object
    CreatedByResponse:
      properties:
        firstName:
          description: First Name.
          nullable: true
          type: string
          x-versionadded: v2.33
        lastName:
          description: Last Name.
          nullable: true
          type: string
          x-versionadded: v2.33
        username:
          description: Username.
          type: string
          x-versionadded: v2.33
      required:
      - firstName
      - lastName
      - username
      type: object
    CreatedCalendarDatasetResponse:
      properties:
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/` to poll
            for the testing job's status.
          type: string
      required:
      - statusId
      type: object
    CreatedDatasetDataEngineResponse:
      properties:
        datasetId:
          description: ID of the output dataset item.
          type: string
        datasetVersionId:
          description: ID of the output dataset version item.
          type: string
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the testing job's status.
          type: string
      required:
      - datasetId
      - datasetVersionId
      - statusId
      type: object
    CreatedDatasetResponse:
      properties:
        catalogId:
          description: The ID of the catalog entry.
          type: string
        catalogVersionId:
          description: The ID of the latest version of the catalog entry.
          type: string
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the testing job's status.
          type: string
      required:
      - catalogId
      - catalogVersionId
      - statusId
      type: object
    CredentialId:
      properties:
        catalogVersionId:
          description: The ID of the latest version of the catalog entry.
          type: string
        credentialId:
          description: The ID of the set of credentials to use instead of user and
            password. Note that with this change, username and password will become
            optional.
          type: string
        url:
          description: The link to retrieve more detailed information about the entity
            that uses this catalog dataset.
          type: string
      required:
      - credentialId
      type: object
    CredentialsAssociationUpdate:
      properties:
        credentialsToAdd:
          description: Objects to associate with given credentials.
          items:
            $ref: '#/components/schemas/CredentialsToAdd'
          minItems: 1
          type: array
        credentialsToRemove:
          description: Object IDs, each of which identifies an object to be disassociated
            from this credential. To see which objects are currently associated, see
            the response from :http:get:`/api/v2/credentials/(credentialId)/associations/`.
          items:
            description: Object ID to be disassociated from given credentials.
            type: string
          minItems: 1
          type: array
      type: object
    CredentialsAssociationsData:
      properties:
        isDefault:
          description: Whether this credential association with the given object is
            default for given session user.
          type: boolean
        link:
          description: Link to get more details about associated object.
          format: uri
          nullable: true
          type: string
        objectId:
          description: Associated object ID.
          type: string
        objectType:
          description: Associated object type.
          type: string
      required:
      - link
      - objectId
      - objectType
      type: object
    CredentialsBody:
      discriminator:
        propertyName: credentialType
      oneOf:
      - properties:
          credentialType:
            description: Credentials type.
            enum:
            - basic
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          password:
            description: Password to store for this credentials.
            type: string
          snowflakeAccountName:
            description: Snowflake account name.
            type: string
            x-versionadded: v2.21
          user:
            description: Username to store for this credentials.
            type: string
        required:
        - name
        - password
        - user
        type: object
      - properties:
          credentialType:
            description: Credentials type.
            enum:
            - oauth
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          refreshToken:
            description: OAUTH token.
            type: string
          token:
            description: OAUTH token.
            type: string
        required:
        - credentialType
        - name
        - refreshToken
        - token
        type: object
      - properties:
          awsAccessKeyId:
            description: AWS access key ID.
            type: string
            x-versionadded: v2.20
          awsSecretAccessKey:
            description: AWS secret access key.
            type: string
            x-versionadded: v2.20
          awsSessionToken:
            description: AWS session token.
            type: string
            x-versionadded: v2.20
          configId:
            description: ID of Secure configurations to share S3 or GCP credentials
              by admin. Alternative to googleConfigId (deprecated).
            type: string
            x-versionadded: v2.32
          credentialType:
            description: Credentials type.
            enum:
            - s3
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          configId:
            description: ID of Secure configurations to share S3 or GCP credentials
              by admin. Alternative to googleConfigId (deprecated).
            type: string
            x-versionadded: v2.32
          credentialType:
            description: Credentials type.
            enum:
            - gcp
            type: string
          description:
            description: Credentials description.
            type: string
          gcpKey:
            $ref: '#/components/schemas/GCPKey'
            description: The Google Cloud Platform (GCP) key (applicable for credentialType
              `gcp` only).Output is the downloaded JSON resulting from creating a
              service account *User Managed Key*  (in the *IAM & admin > Service accounts
              section* of GCP).
            x-versionadded: v2.21
          googleConfigId:
            description: ID of Google configurations shared by admin (deprecated).
              Please use configId instead.
            type: string
            x-versionadded: v2.30
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          azureConnectionString:
            description: Azure connection string.
            type: string
            x-versionadded: v2.21
          credentialType:
            description: Credentials type.
            enum:
            - azure
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - azureConnectionString
        - credentialType
        - name
        type: object
      - properties:
          azureTenantId:
            description: Tenant ID of the Azure AD service principal.
            type: string
            x-versionadded: v2.30
          clientId:
            description: Client ID of the Azure AD service principal.
            type: string
            x-versionadded: v2.30
          clientSecret:
            description: Client Secret of the Azure AD service principal.
            type: string
            x-versionadded: v2.30
          credentialType:
            description: Credentials type.
            enum:
            - azure_service_principal
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - azureTenantId
        - clientId
        - clientSecret
        - credentialType
        - name
        type: object
      - properties:
          clientId:
            description: Snowflake OAUTH client ID.
            type: string
            x-versionadded: v2.23
          clientSecret:
            description: Snowflake OAUTH client secret.
            type: string
            x-versionadded: v2.23
          credentialType:
            description: Credentials type.
            enum:
            - snowflake_oauth_user_account
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          oauthConfigId:
            description: ID of snowflake OAuth configurations shared by admin.
            type: string
            x-versionadded: v2.30
          oauthIssuerType:
            description: OAuth issuer type.
            enum:
            - azure
            - okta
            - snowflake
            type: string
            x-versionadded: v2.27
          oauthIssuerUrl:
            description: OAuth issuer URL.
            format: uri
            type: string
            x-versionadded: v2.27
          oauthScopes:
            description: OAuth scopes.
            items:
              description: OAuth scope.
              type: string
            minItems: 1
            type: array
            x-versionadded: v2.27
          snowflakeAccountName:
            description: Snowflake account name.
            type: string
            x-versionadded: v2.21
        required:
        - credentialType
        - name
        type: object
      - properties:
          clientId:
            description: ADLS Gen2 OAuth client ID.
            type: string
            x-versionadded: v2.27
          clientSecret:
            description: ADLS Gen2 OAuth client secret.
            type: string
            x-versionadded: v2.27
          credentialType:
            description: Credentials type.
            enum:
            - adls_gen2_oauth
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          oauthScopes:
            description: ADLS Gen2 OAuth scopes.
            items:
              description: ADLS Gen2 OAuth scope.
              type: string
            minItems: 1
            type: array
            x-versionadded: v2.27
        required:
        - clientId
        - clientSecret
        - credentialType
        - name
        - oauthScopes
        type: object
      - properties:
          credentialType:
            description: Credentials type.
            enum:
            - tableau_access_token
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          personalAccessToken:
            description: Tableau personal access token.
            minLength: 1
            type: string
            x-versionadded: v2.29
          tokenName:
            description: Tableau token name.
            maxLength: 50
            minLength: 1
            type: string
            x-versionadded: v2.29
        required:
        - credentialType
        - name
        - personalAccessToken
        - tokenName
        type: object
      - properties:
          configId:
            description: ID of Snowflake Key Pair Credentials Secure configurations
              to share by admin
            type: string
            x-versionadded: v2.32
          credentialType:
            description: Credentials type.
            enum:
            - snowflake_key_pair_user_account
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          passphrase:
            description: Optional passphrase to encrypt private key.
            minLength: 1
            type: string
            x-versionadded: v2.30
          privateKeyStr:
            description: Private key for key pair authentication.
            minLength: 1
            type: string
            x-versionadded: v2.30
          user:
            description: Username for this credential.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          credentialType:
            description: Credentials type.
            enum:
            - databricks_access_token_account
            type: string
          databricksAccessToken:
            description: Databricks personal access token.
            minLength: 1
            type: string
            x-versionadded: v2.31
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - databricksAccessToken
        - name
        type: object
      - properties:
          clientId:
            description: Client ID for Databricks Service Principal.
            type: string
            x-versionadded: v2.33
          clientSecret:
            description: Client secret for Databricks Service Principal.
            type: string
            x-versionadded: v2.33
          configId:
            description: ID of Databricks Service Principal Credentials Secure configuration
              to share by admin
            type: string
            x-versionadded: v2.33
          credentialType:
            description: Credentials type.
            enum:
            - databricks_service_principal_account
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          apiToken:
            description: API token.
            minLength: 1
            type: string
            x-versionadded: v2.31
          credentialType:
            description: Credentials type.
            enum:
            - api_token
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - apiToken
        - credentialType
        - name
        type: object
    CredentialsListAssociationsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Objects associated with the specified credentials.
          items:
            $ref: '#/components/schemas/CredentialsAssociationsData'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CredentialsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of credentials.
          items:
            $ref: '#/components/schemas/CreateCredentialsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CredentialsToAdd:
      properties:
        objectId:
          description: Object ID identifying the object to be associated with the
            credentials.
          type: string
        objectType:
          description: Type of object associated with the credentials.
          enum:
          - dataconnection
          type: string
      required:
      - objectId
      - objectType
      type: object
    CredentialsUpdate:
      properties:
        apiToken:
          description: API token.
          minLength: 1
          type: string
          x-versionadded: v2.31
        awsAccessKeyId:
          description: AWS access key ID (applicable for credentialType `s3` only).
          type: string
        awsSecretAccessKey:
          description: The AWS secret access key (applicable for credentialType `s3`
            only).
          type: string
        awsSessionToken:
          description: The AWS session token (applicable for credentialType `s3` only).
          type: string
        azureConnectionString:
          description: Azure connection string (applicable for credentialType `azure`
            only).
          type: string
          x-versionadded: v2.21
        azureTenantId:
          description: Tenant ID of the Azure AD service principal (applicable for
            credentialType `azure_service_principal` only).
          type: string
          x-versionadded: v2.30
        clientId:
          description: OAUTH client ID (applicable for credentialType `snowflake_oauth_user_account`,
            `adls_gen2_oauth` and `azure_service_principal`).
          type: string
          x-versionadded: v2.23
        clientSecret:
          description: OAUTH client secret (applicable for credentialType `snowflake_oauth_user_account`,
            `adls_gen2_oauth` and `azure_service_principal`).
          type: string
          x-versionadded: v2.23
        configId:
          description: ID of Secure configurations to share S3 or GCP credentials
            by Admin. Alternative to googleConfigId (deprecated).
          type: string
          x-versionadded: v2.32
        databricksAccessToken:
          description: Databricks personal access token.
          minLength: 1
          type: string
          x-versionadded: v2.31
        description:
          description: Description of credentials. If omitted, and name is not omitted,
            clears any previous description for that name.
          type: string
        gcpKey:
          $ref: '#/components/schemas/GCPKey'
          description: The Google Cloud Platform (GCP) key (applicable for credentialType
            `gcp` only).Output is the downloaded JSON resulting from creating a service
            account *User Managed Key*  (in the *IAM & admin > Service accounts section*
            of GCP).
          x-versionadded: v2.21
        googleConfigId:
          description: ID of Google configurations shared by admin (deprecated). Please
            use configId instead.
          type: string
          x-versionadded: v2.30
        name:
          description: Name of credentials.
          type: string
        oauthConfigId:
          description: ID of snowflake OAuth configurations shared by admin.
          type: string
          x-versionadded: v2.30
        oauthIssuerType:
          description: Snowflake IDP issuer type (applicable for credentialType `snowflake_oauth_user_account`
            only).
          enum:
          - azure
          - okta
          - snowflake
          type: string
          x-versionadded: v2.27
        oauthIssuerUrl:
          description: Snowflake External IDP issuer URL (applicable for Snowflake
            External OAUTH connections only).
          format: uri
          type: string
          x-versionadded: v2.27
        oauthScopes:
          description: External OAUTH scopes (applicable for Snowflake External OAUTH
            connections and credentialType `snowflake_oauth_user_account`).
          items:
            description: AUTH scope.
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.27
        passphrase:
          description: Optional passphrase to encrypt private key.(applicable for
            credentialType `snowflake_key_pair_user_account` only).
          minLength: 1
          type: string
          x-versionadded: v2.30
        password:
          description: Password to update for this set of credentials (applicable
            for credentialType `basic` only).
          type: string
        personalAccessToken:
          description: Tableau personal access token (PAT). (applicable for Tableau
            AUTH connections only).
          type: string
          x-versionadded: v2.29
        privateKeyStr:
          description: Private key for key pair authentication.(applicable for credentialType
            `snowflake_key_pair_user_account` only).
          minLength: 1
          type: string
          x-versionadded: v2.30
        refreshToken:
          description: OAUTH refresh token (applicable for credentialType `oauth`
            only).
          type: string
        snowflakeAccountName:
          description: Snowflake account name (applicable for `snowflake_oauth_user_account`
            only).
          type: string
          x-versionadded: v2.21
        token:
          description: OAUTH token (applicable for credentialType `oauth` only).
          type: string
        tokenName:
          description: Tableau token name. (applicable for Tableau AUTH connections
            only).
          type: string
          x-versionadded: v2.29
        user:
          description: Username to update for this set of credentials (applicable
            for credentialType `basic` and `snowflake_key_pair_user_account` only).
          type: string
      type: object
    CrossClassAccuracy:
      properties:
        feature:
          description: The name of the categorical feature.
          type: string
        modelId:
          description: ID of the model for the cross-class accuracy scores.
          type: string
        perClassAccuracyScores:
          description: An array of metric scores for each class of the feature.
          items:
            $ref: '#/components/schemas/PerClassAccuracy'
          type: array
        predictionThreshold:
          description: Value of the prediction threshold for the model.
          maximum: 1.0
          minimum: 0.0
          type: number
      required:
      - feature
      - modelId
      - perClassAccuracyScores
      - predictionThreshold
      type: object
    CrossClassAccuracyCreateResponse:
      properties:
        statusId:
          description: The ID of the status object.
          type: string
      required:
      - statusId
      type: object
    CrossClassAccuracyList:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of cross-class accuracy scores for the model.
          items:
            $ref: '#/components/schemas/CrossClassAccuracy'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CrossSeriesGroupByColumnRetrieveResponse:
      properties:
        crossSeriesGroupByColumns:
          description: A list of columns with information about each column's eligibility
            as a cross-series group-by column.
          items:
            $ref: '#/components/schemas/CrossSeriesGroupByColumnsListItem'
          type: array
        multiseriesId:
          description: The name of the multiseries ID column.
          type: string
      required:
      - crossSeriesGroupByColumns
      - multiseriesId
      type: object
    CrossSeriesGroupByColumnValidatePayload:
      properties:
        crossSeriesGroupByColumns:
          description: If specified, these columns will be validated for usage as
            the group-by column for creating cross-series features. If not present,
            then all columns from the dataset will be validated and only the eligible
            ones returned. To be valid, a column should be categorical or numerical
            (but not float), not be the series ID or equivalent to the series ID,
            not split any series, and not consist of only one value.
          items:
            type: string
          type: array
        datetimePartitionColumn:
          description: The name of the column that will be used as the datetime partitioning
            column.
          type: string
        multiseriesIdColumn:
          description: The name of the column that wil be used as the multiseries
            ID column for this project.
          type: string
        userDefinedSegmentIdColumn:
          description: The name of the column that wil be used as the user defined
            segment ID column for this project.
          type: string
          x-versionadded: v2.24
      required:
      - datetimePartitionColumn
      - multiseriesIdColumn
      type: object
    CrossSeriesGroupByColumnValidateResponse:
      properties:
        message:
          description: An extended message about the result. For example, if a job
            is submitted that is a duplicate of a job that has already been added
            to the queue, the message will mention that no new job was created.
          type: string
      required:
      - message
      type: object
    CrossSeriesGroupByColumnsListItem:
      properties:
        eligibility:
          description: Information about the column's eligibility. If the column is
            not eligible, this will include the reason why.
          type: string
        isEligible:
          description: Indicates whether this column can be used as a group-by column.
          type: boolean
        name:
          description: The name of the column.
          type: string
      required:
      - eligibility
      - isEligible
      - name
      type: object
    CrossValidationRetrieveResponse:
      properties:
        cvScores:
          description: A dictionary `cvScores` with sub-dictionary keyed by `partition_id`,
            each `partition_id` is itself a dictionary keyed by `metric_name` where
            the value is the reading for that particular metric for the partition_id.
          example: "\n        {\n            \"cvScores\": {\n                \"FVE\
            \ Gamma\": {\n                    \"0.0\": 0.24334,\n                \
            \    \"1.0\": 0.17757,\n                    \"2.0\": 0.21803,\n      \
            \              \"3.0\": 0.20185,\n                    \"4.0\": 0.20576\n\
            \                },\n                \"FVE Poisson\": {\n            \
            \        \"0.0\": 0.24527,\n                    \"1.0\": 0.22092,\n  \
            \                  \"2.0\": 0.22451,\n                    \"3.0\": 0.24417,\n\
            \                    \"4.0\": 0.21654\n                }\n           \
            \ }\n        }\n"
          type: object
      required:
      - cvScores
      type: object
    CustomBoundaries:
      properties:
        lower:
          description: All predictions less than provided value are considered anomalous.
          type: number
        upper:
          description: All predictions greater than provided value are considered
            anomalous.
          type: number
      required:
      - lower
      - upper
      type: object
    CustomJobFileResponse:
      properties:
        content:
          description: Content of the chosen file.
          type: string
          x-versionadded: v2.33
        fileName:
          description: Name of the chosen file.
          type: string
          x-versionadded: v2.33
        filePath:
          description: Path of the chosen file.
          type: string
          x-versionadded: v2.33
        id:
          description: The ID of the custom job.
          type: string
          x-versionadded: v2.33
      required:
      - content
      - fileName
      - filePath
      - id
      type: object
    CustomJobLimitsResponse:
      properties:
        maxCustomJobRuns:
          description: Number of custom jobs allowed to run in parallel.
          type: integer
          x-versionadded: v2.33
        maxCustomJobTimeout:
          description: Execution time limit for the custom job in seconds.
          type: integer
          x-versionadded: v2.33
      required:
      - maxCustomJobRuns
      - maxCustomJobTimeout
      type: object
    CustomJobListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of custom jobs.
          items:
            $ref: '#/components/schemas/CustomJobResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomJobResources:
      properties:
        egressNetworkPolicy:
          description: Egress network policy.
          enum:
          - none
          - public
          type: string
          x-versionadded: v2.33
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
      required:
      - egressNetworkPolicy
      type: object
    CustomJobResponse:
      properties:
        created:
          description: ISO-8601 timestamp of when the custom job was created.
          type: string
          x-versionadded: v2.33
        description:
          description: The description of the custom job.
          maxLength: 10000
          type: string
          x-versionadded: v2.33
        entryPoint:
          description: The ID of the entry point file to use.
          nullable: true
          type: string
          x-versionadded: v2.33
        environmentId:
          description: The ID of the execution environment used for this custom job.
          nullable: true
          type: string
          x-versionadded: v2.33
        environmentVersionId:
          description: The ID of the execution environment version used for this custom
            job.
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: The ID of the custom job.
          type: string
          x-versionadded: v2.33
        items:
          description: List of file items.
          items:
            $ref: '#/components/schemas/WorkspaceItemResponse'
          type: array
          x-versionadded: v2.33
        jobType:
          description: Type of the custom job.
          enum:
          - default
          - hostedCustomMetric
          - notification
          - retraining
          type: string
          x-versionadded: v2.33
        lastRun:
          description: The last custom job run.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the custom job.
          type: string
          x-versionadded: v2.33
        resources:
          $ref: '#/components/schemas/CustomJobResources'
          description: The custom job resources that will be applied in the k8s cluster.
          x-versionadded: v2.33
        runtimeParameters:
          description: Unified view of the defined runtime parameters for this custom
            job along with any values that are currently set that override the default
            value from their definition.
          items:
            $ref: '#/components/schemas/RuntimeParameterUnified'
          type: array
          x-versionadded: v2.33
        updated:
          description: ISO-8601 timestamp of when custom job was last updated.
          type: string
          x-versionadded: v2.33
      required:
      - created
      - environmentId
      - environmentVersionId
      - id
      - items
      - jobType
      - lastRun
      - name
      - resources
      - updated
      type: object
    CustomJobRunListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of custom job runs.
          items:
            $ref: '#/components/schemas/CustomJobRunResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomJobRunResponse:
      properties:
        created:
          description: ISO-8601 timestamp of when the model was created.
          type: string
          x-versionadded: v2.33
        customJobId:
          description: The ID of the custom job.
          type: string
          x-versionadded: v2.33
        description:
          description: The description of the custom job run.
          maxLength: 10000
          type: string
          x-versionadded: v2.33
        duration:
          description: Duration of the custom test run is seconds.
          type: number
          x-versionadded: v2.33
        entryPoint:
          description: The entry point file item ID in the custom job's workspace.
          type: string
          x-versionadded: v2.33
        id:
          description: The ID of the custom job.
          type: string
          x-versionadded: v2.33
        items:
          description: List of file items.
          items:
            $ref: '#/components/schemas/WorkspaceItemResponse'
          type: array
          x-versionadded: v2.33
        jobStatusId:
          description: ID to track the custom job run execution status.
          nullable: true
          type: string
          x-versionadded: v2.33
        resources:
          $ref: '#/components/schemas/CustomJobResources'
          description: The custom job resources that will be applied in the k8s cluster.
          x-versionadded: v2.33
        runtimeParameters:
          description: Unified view of the defined runtime parameters for this custom
            job along with any values that are currently set that override the default
            value from their definition.
          items:
            $ref: '#/components/schemas/RuntimeParameterUnified'
          type: array
          x-versionadded: v2.33
        status:
          description: The status of the custom job run.
          enum:
          - succeeded
          - failed
          - running
          - interrupted
          - canceling
          - canceled
          type: string
          x-versionadded: v2.33
      required:
      - created
      - customJobId
      - duration
      - id
      - items
      - jobStatusId
      - resources
      - status
      type: object
    CustomMetricBatchSummary:
      properties:
        metric:
          $ref: '#/components/schemas/MetricSummary'
          description: Summary of the custom metric.
          x-versionadded: v2.33
      required:
      - metric
      type: object
    CustomMetricCondition:
      properties:
        compareOperator:
          description: Defines how custom metric value is compared against the threshold.
          enum:
          - lt
          - lte
          - gt
          - gte
          type: string
          x-versionadded: v2.33
        metricId:
          description: Custom metric ID.
          type: string
          x-versionadded: v2.33
        threshold:
          description: Threshold value used to determine if the condition is met.
          type: number
          x-versionadded: v2.33
      required:
      - compareOperator
      - metricId
      - threshold
      type: object
    CustomMetricDetails:
      properties:
        earliestDate:
          description: The earliest date of the custom metrics values.
          format: date-time
          nullable: true
          type: string
        latestDate:
          description: The latest date of the custom metrics values.
          format: date-time
          nullable: true
          type: string
      required:
      - earliestDate
      - latestDate
      type: object
    CustomMetricSegmentDataset:
      properties:
        column:
          description: Name of the column that contains segment values.
          type: string
        name:
          description: Name of the segment on which segment analysis is being performed.
          type: string
        value:
          description: Value of the segment attribute to segment on.
          type: string
      required:
      - name
      type: object
    CustomMetricSummary:
      properties:
        metric:
          $ref: '#/components/schemas/MetricSummary'
          description: Summary of the custom metric.
        period:
          $ref: '#/components/schemas/MetricPeriodBucket'
          description: A time period defined by a start and end time.
      required:
      - metric
      - period
      type: object
    CustomMetricsBulkBatchSummary:
      properties:
        metrics:
          default: []
          description: Custom metrics summaries.
          items:
            $ref: '#/components/schemas/MetricSummary'
          maxItems: 10
          type: array
          x-versionadded: v2.33
      required:
      - metrics
      type: object
    CustomMetricsBulkSummary:
      properties:
        details:
          $ref: '#/components/schemas/CustomMetricDetails'
          default: {}
          description: Additional information related to custom metrics.
        metrics:
          default: []
          description: Custom metrics summaries.
          items:
            $ref: '#/components/schemas/MetricSummary'
          maxItems: 10
          type: array
        period:
          $ref: '#/components/schemas/MetricPeriodBucket'
          description: A time period defined by a start and end time.
      required:
      - details
      - metrics
      - period
      type: object
    CustomMetricsHealth:
      properties:
        failingConditions:
          description: Conditions for failing status.
          items:
            $ref: '#/components/schemas/CustomMetricCondition'
          maxItems: 25
          type: array
          x-versionadded: v2.33
        warningConditions:
          description: Conditions for warning status.
          items:
            $ref: '#/components/schemas/CustomMetricCondition'
          maxItems: 25
          type: array
          x-versionadded: v2.33
      type: object
    CustomModelAccessControlListResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: List of the requested custom model access control entries.
          items:
            $ref: '#/components/schemas/CustomModelAccessControlResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    CustomModelAccessControlResponse:
      properties:
        canShare:
          description: Whether this user can share this custom model
          type: boolean
        role:
          description: This users role.
          type: string
        userId:
          description: This user's userId.
          type: string
        username:
          description: The username for this user's entry.
          type: string
      required:
      - canShare
      - role
      - userId
      - username
      type: object
    CustomModelAccessControlUpdateResponse:
      properties:
        data:
          description: Roles were successfully updated.
          items:
            $ref: '#/components/schemas/CustomModelAccessControlResponse'
          type: array
      required:
      - data
      type: object
    CustomModelAsyncOperationResponse:
      properties:
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the testing job's status
          type: string
      required:
      - statusId
      type: object
    CustomModelConversionAsyncOperationResponse:
      properties:
        conversionId:
          description: ID that can be used to stop a given conversion.
          type: string
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the testing job's status
          type: string
      required:
      - conversionId
      - statusId
      type: object
    CustomModelCopy:
      properties:
        customModelId:
          description: ID of the custom model to copy.
          type: string
      required:
      - customModelId
      type: object
    CustomModelCreate:
      properties:
        calibratePredictions:
          default: 'True'
          description: Whether model predictions should be calibrated by DataRobot.Only
            applies to anomaly detection training tasks; we recommend this if you
            have not already included calibration in your model code.Calibration improves
            the probability estimates of a model, and modifies the predictions of
            non-probabilistic models to be interpretable as probabilities. This will
            facilitate comparison to DataRobot models, and give access to ROC curve
            insights on external data.
          type: boolean
          x-versionadded: v2.23
        classLabels:
          description: The class labels for multiclass classification. Required for
            multiclass inference models. If using one of the [DataRobot] base environments
            and your model produces an ndarray of unlabeled class probabilities, the
            order of the labels should match the order of the predicted output
          items:
            type: string
          maxItems: 100
          type: array
        customModelType:
          description: The type of custom model.
          enum:
          - training
          - inference
          type: string
          x-versiondeprecated: v2.28
        description:
          description: The user-friendly description of the model.
          maxLength: 10000
          type: string
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model. The Git information may either refer to changes at a model
            level or at a model version level.
          x-versionadded: v2.31
        isTrainingDataForVersionsPermanentlyEnabled:
          description: Indicates that training data assignment is now permanently
            at the version level only for the custom model. Once enabled, this cannot
            be disabled. Training data assignment on the model level :http:patch:`/api/v2/customModels/(customModelId)/trainingData/`
            will be permanently disabled for this particular model.
          type: boolean
          x-versionadded: v2.30
        language:
          description: Programming language name in which model is written.
          maxLength: 500
          type: string
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.30
        name:
          description: The user-friendly name for the model.
          maxLength: 255
          type: string
        negativeClassLabel:
          description: The negative class label for custom models that support binary
            classification. If specified, `positiveClassLabel` must also be specified.
            Default value is "0".
          maxLength: 500
          nullable: true
          type: string
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - DR_API_ACCESS
          - PUBLIC
          nullable: true
          type: string
          x-versiondeprecated: v2.30
        playgroundId:
          description: ID of the GenAI Playground associated with the given custom
            inference model.
          nullable: true
          type: string
          x-versionadded: v2.33
        positiveClassLabel:
          description: The positive class label for custom models that support binary
            classification. If specified, `negativeClassLabel` must also be specified.
            Default value is "1".
          maxLength: 500
          nullable: true
          type: string
        predictionThreshold:
          default: 0.5
          description: The prediction threshold which will be used for binary classification
            custom model.
          maximum: 1.0
          minimum: 0
          type: number
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
          x-versiondeprecated: v2.30
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
          x-versiondeprecated: v2.30
        supportsBinaryClassification:
          description: Whether the model supports binary classification.
          type: boolean
          x-versiondeprecated: v2.23
        supportsRegression:
          description: Whether the model supports regression.
          type: boolean
          x-versiondeprecated: v2.23
        targetName:
          description: The name of the target for labeling predictions. Required for
            model type 'inference'. Specifying this value for a model type 'training'
            will result in an error.
          maxLength: 500
          nullable: true
          type: string
        targetType:
          description: The target type of the custom model
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - Unstructured
          type: string
          x-versionadded: v2.23
        userProvidedId:
          description: A user-provided unique ID associated with the given custom
            inference model.
          maxLength: 100
          type: string
          x-versionadded: v2.29
      required:
      - customModelType
      - name
      type: object
    CustomModelDeploymentListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom model deployments.
          items:
            $ref: '#/components/schemas/CustomModelDeploymentResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomModelDeploymentResponse:
      properties:
        customModel:
          $ref: '#/components/schemas/CustomModelShortResponse'
          description: Custom model associated with this deployment.
        customModelImageId:
          description: The id of the custom model image associated with this deployment.
          type: string
        customModelVersion:
          $ref: '#/components/schemas/CustomModelVersionShortResponse'
          description: Custom model version associated with this deployment.
        deployed:
          description: ISO-8601 timestamp of when deployment was created.
          type: string
        deployedBy:
          description: The username of the user that deployed the custom model.
          type: string
        executionEnvironment:
          $ref: '#/components/schemas/ExecutionEnvironmentShortResponse'
          description: Execution environment associated with this deployment.
        executionEnvironmentVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionShortResponse'
          description: Execution environment version associated with this deployment.
        id:
          description: The ID of the deployment.
          type: string
        imageType:
          description: The type of the image, either customModelImage if the testing
            attempt is using a customModelImage as its model or customModelVersion
            if the testing attempt is using a customModelVersion with dependency management.
          enum:
          - customModelImage
          - customModelVersion
          type: string
        label:
          description: User-friendly name of the model deployment.
          type: string
        status:
          description: Deployment status.
          enum:
          - active
          - archived
          - errored
          - inactive
          - launching
          - replacingModel
          - stopping
          type: string
        testingStatus:
          description: Latest testing status of the deployed custom model image.
          enum:
          - not_tested
          - queued
          - failed
          - canceled
          - succeeded
          - in_progress
          - aborted
          - warning
          - skipped
          type: string
      required:
      - customModel
      - customModelImageId
      - customModelVersion
      - deployed
      - deployedBy
      - executionEnvironment
      - executionEnvironmentVersion
      - id
      - label
      - status
      - testingStatus
      type: object
    CustomModelDetails:
      properties:
        createdAt:
          description: Time when the custom model was created
          type: string
        creatorEmail:
          description: Email of the user who created the custom model
          nullable: true
          type: string
        creatorId:
          description: ID of the creator of the custom model
          type: string
        creatorName:
          description: Name of the user who created the custom model
          nullable: true
          type: string
        id:
          description: ID of the associated custom model
          type: string
      required:
      - createdAt
      - creatorId
      - id
      type: object
    CustomModelListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom models.
          items:
            $ref: '#/components/schemas/CustomModelResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomModelPredictionExplanations:
      properties:
        customModelId:
          description: ID of the custom model.
          type: string
        customModelVersionId:
          description: ID of the custom model version.
          type: string
        environmentId:
          description: The ID of environment to use. If not specified, the customModelVersion's
            dependency environment will be used.
          type: string
        environmentVersionId:
          description: The ID of environment version to use. Defaults to the latest
            successfully built version.
          type: string
      required:
      - customModelId
      - customModelVersionId
      type: object
    CustomModelResourceLimits:
      properties:
        desiredCustomModelContainerSize:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        maxCustomModelContainerSize:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        maxCustomModelReplicasPerDeployment:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        maxCustomModelTestingParallelUsers:
          description: The maximum number of parallel users that can be used for Custom
            Model Testing checks
          exclusiveMinimum: true
          maximum: 20
          minimum: 0
          type: integer
      required:
      - maxCustomModelTestingParallelUsers
      type: object
    CustomModelResponse:
      properties:
        calibratePredictions:
          description: Determines whether ot not predictions should be calibrated
            by DataRobot.Only applies to anomaly detection.
          type: boolean
        classLabels:
          description: If the model is a multiclass classifier, these are the model's
            class labels
          items:
            type: string
          type: array
        created:
          description: ISO-8601 timestamp of when the model was created.
          type: string
        createdBy:
          description: The username of the custom model creator.
          type: string
        customModelType:
          description: The type of custom model.
          enum:
          - training
          - inference
          type: string
        deploymentsCount:
          description: The number of models deployed.
          type: integer
        description:
          description: The description of the model.
          type: string
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model version.
          x-versionadded: v2.31
        id:
          description: The ID of the custom model.
          type: string
        isTrainingDataForVersionsPermanentlyEnabled:
          description: 'Indicates that training data assignment is now permanently
            at the version level only                 for the custom model. Once enabled,
            this cannot be disabled.                 Assigning training data on the
            model level :http:patch:`/api/v2/customModels/(customModelId)/trainingData/`                 will
            be permanently disabled and return HTTP 422 for this particular model.                 Use
            training data assignment at the version level:                 :http:post:`/api/v2/customModels/(customModelId)/versions/`                 :http:patch:`/api/v2/customModels/(customModelId)/versions/`                 '
          type: boolean
          x-versionadded: v2.30
        language:
          description: The programming language used to write the model.
          type: string
        latestVersion:
          $ref: '#/components/schemas/CustomModelVersionResponse'
          description: The latest version for the custom model (if this field is empty,
            the model is not ready for use).
          nullable: true
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.30
        name:
          description: The name of the model.
          type: string
        negativeClassLabel:
          description: If the model is a binary classifier, this is the negative class
            label.
          type: string
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - DR_API_ACCESS
          - PUBLIC
          nullable: true
          type: string
          x-versiondeprecated: v2.30
        playgroundId:
          description: ID of the GenAI Playground associated with the given custom
            inference model.
          nullable: true
          type: string
          x-versionadded: v2.33
        positiveClassLabel:
          description: If the model is a binary classifier, this is the positive class
            label.
          type: string
        predictionThreshold:
          description: If the model is a binary classifier, this is the prediction
            threshold.
          type: number
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
          x-versiondeprecated: v2.30
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
          x-versiondeprecated: v2.30
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
        supportsAnomalyDetection:
          description: Whether the model supports anomaly detection.
          type: boolean
        supportsBinaryClassification:
          description: Whether the model supports binary classification.
          type: boolean
        supportsRegression:
          description: Whether the model supports regression.
          type: boolean
        targetName:
          description: The name of the target for labeling predictions.
          type: string
        targetType:
          description: The target type of custom model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - Unstructured
          type: string
        trainingDataAssignmentInProgress:
          description: Indicates if training data is currently being assigned to the
            custom model.
          type: boolean
        trainingDataFileName:
          description: The name of the file that was used as training data if it was
            assigned previously.
          nullable: true
          type: string
        trainingDataPartitionColumn:
          description: The name of the column containing the partition assignments
            in training data if it was assigned previously and partitioning was provided.
          nullable: true
          type: string
        trainingDatasetId:
          description: The ID of the dataset that was used as training data if it
            was assigned previously.
          nullable: true
          type: string
        trainingDatasetVersionId:
          description: The ID of the dataset version that was used as training data
            if it was assigned previously.
          nullable: true
          type: string
        updated:
          description: ISO-8601 timestamp of when model was last updated.
          type: string
        userProvidedId:
          description: A user-provided unique ID associated with the given custom
            inference model.
          maxLength: 100
          type: string
      required:
      - created
      - createdBy
      - deploymentsCount
      - description
      - id
      - language
      - latestVersion
      - name
      - supportsBinaryClassification
      - supportsRegression
      - targetType
      - updated
      type: object
    CustomModelShortResponse:
      properties:
        id:
          description: The ID of the custom model.
          type: string
        name:
          description: User-friendly name of the model.
          type: string
      required:
      - id
      - name
      type: object
    CustomModelTesting:
      properties:
        errorCheck:
          $ref: '#/components/schemas/TestingStatus'
          description: Ensures that the model can make predictions on the provided
            test dataset.
        longRunningService:
          $ref: '#/components/schemas/TestingStatus'
          description: Ensures that the custom model image can build and launch. If
            it cannot, the test is marked as Failed and subsequent test are aborted.
        nullValueImputation:
          $ref: '#/components/schemas/TestingStatus'
          description: Verifies that the model can impute null values. Required for
            Feature Impact.
        sideEffects:
          $ref: '#/components/schemas/TestingStatus'
          description: Verifies that predictions made on the dataset match row-wise
            predictions for the same dataset. Fails if the predictions do not match.
      type: object
    CustomModelTests:
      properties:
        configuration:
          $ref: '#/components/schemas/CustomModelTestsConfig'
          description: Key value map of Testing type and Testing type config.
        customModelId:
          description: The ID of the custom model to test.
          type: string
        customModelVersionId:
          description: The ID of custom model version to use.
          type: string
        datasetId:
          description: The ID of the dataset to use for testing. Dataset ID is required
            for regular (non-unstructured) custom models.
          type: string
        datasetVersionId:
          description: The ID of the version of the dataset item to use as the testing
            dataset. Defaults to the latest version.
          type: string
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model. This setting is incompatible with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        environmentId:
          description: The ID of environment to use. If not specified, the customModelVersion's
            dependency environment will be used.
          type: string
          x-versiondeprecated: v2.23
        environmentVersionId:
          description: The ID of environment version to use. Defaults to the latest
            successfully built version.
          type: string
          x-versiondeprecated: v2.23
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed. This setting is incompatible
            with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          nullable: true
          type: string
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
      required:
      - customModelId
      - customModelVersionId
      type: object
    CustomModelTestsConfig:
      properties:
        errorCheck:
          default: fail
          description: Ensures that the model can make predictions on the provided
            test dataset.
          enum:
          - fail
          - skip
          type: string
        longRunningService:
          default: fail
          description: Ensures that the custom model image can build and launch. If
            it cannot, the test is marked as Failed and subsequent test are aborted.
          enum:
          - fail
          type: string
        nullValueImputation:
          default: warn
          description: Verifies that the model can impute null values. Required for
            Feature Impact.
          enum:
          - skip
          - warn
          - fail
          type: string
        sideEffects:
          default: warn
          description: Verifies that predictions made on the dataset match row-wise
            predictions for the same dataset. Fails if the predictions do not match.
          enum:
          - skip
          - warn
          - fail
          type: string
      type: object
    CustomModelTestsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom model tests.
          items:
            $ref: '#/components/schemas/CustomModelTestsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomModelTestsLogTailResponse:
      properties:
        log:
          description: The N lines of the log.
          type: string
      required:
      - log
      type: object
    CustomModelTestsResponse:
      properties:
        completedAt:
          description: ISO-8601 timestamp of when the testing attempt was completed.
          type: string
        created:
          description: ISO-8601 timestamp of when the testing entry was created.
          type: string
        createdBy:
          description: The username of the user that started the custom model test.
          type: string
        customModel:
          $ref: '#/components/schemas/CustomModelShortResponse'
          description: Custom model used for testing.
        customModelImageId:
          description: If testing was successful, ID of the custom inference model
            image that can be used for a deployment, otherwise null.
          nullable: true
          type: string
        customModelVersion:
          $ref: '#/components/schemas/CustomModelVersionShortResponse'
          description: Custom model version used for testing.
        datasetId:
          description: ID of the dataset used for testing.
          type: string
        datasetVersionId:
          description: ID of the specific dataset version used for testing.
          type: string
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model. This setting is incompatible with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        executionEnvironment:
          $ref: '#/components/schemas/ExecutionEnvironmentShortResponse'
          description: Execution environment used for testing.
        executionEnvironmentVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionShortResponse'
          description: Execution environment version used for testing.
        id:
          description: ID of the testing history entry.
          type: string
        imageType:
          description: The type of the image, either customModelImage if the testing
            attempt is using a customModelImage as its model or customModelVersion
            if the testing attempt is using a customModelVersion with dependency management.
          enum:
          - customModelImage
          - customModelVersion
          type: string
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed. This setting is incompatible
            with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          nullable: true
          type: string
        overallStatus:
          description: The overall status of the testing history entry.
          enum:
          - not_tested
          - queued
          - failed
          - canceled
          - succeeded
          - in_progress
          - aborted
          - warning
          - skipped
          type: string
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
        testingStatus:
          $ref: '#/components/schemas/CustomModelTesting'
          description: Maps the testing types to their status and message for the
            testing entry. Testing type represents a single check executed during
            the test.
      required:
      - completedAt
      - created
      - createdBy
      - customModel
      - customModelImageId
      - customModelVersion
      - datasetId
      - datasetVersionId
      - executionEnvironment
      - executionEnvironmentVersion
      - id
      - overallStatus
      - testingStatus
      type: object
    CustomModelUpdate:
      properties:
        classLabels:
          description: The class labels for multiclass classification. Required for
            multiclass inference models. If using one of the [DataRobot] base environments
            and your model produces an ndarray of unlabeled class probabilities, the
            order of the labels should match the order of the predicted output
          items:
            type: string
          maxItems: 100
          type: array
        description:
          description: The user-friendly description of the model.
          maxLength: 10000
          type: string
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model. The Git information may either refer to changes at a model
            level or at a model version level.
          x-versionadded: v2.31
        isTrainingDataForVersionsPermanentlyEnabled:
          description: Indicates that training data assignment is now permanently
            at the version level only for the custom model. Once enabled, this cannot
            be disabled. Training data assignment on the model level :http:patch:`/api/v2/customModels/(customModelId)/trainingData/`
            will be permanently disabled for this particular model.
          type: boolean
          x-versionadded: v2.30
        language:
          description: Programming language name in which model is written.
          maxLength: 500
          type: string
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.30
        name:
          description: The user-friendly name for the model.
          maxLength: 255
          type: string
        negativeClassLabel:
          description: The negative class label for custom models that support binary
            classification. If specified, `positiveClassLabel` must also be specified.
            Default value is "0".
          maxLength: 500
          nullable: true
          type: string
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - DR_API_ACCESS
          - PUBLIC
          nullable: true
          type: string
          x-versiondeprecated: v2.30
        positiveClassLabel:
          description: The positive class label for custom models that support binary
            classification. If specified, `negativeClassLabel` must also be specified.
            Default value is "1".
          maxLength: 500
          nullable: true
          type: string
        predictionThreshold:
          default: 0.5
          description: The prediction threshold which will be used for binary classification
            custom model.
          maximum: 1.0
          minimum: 0
          type: number
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
          x-versiondeprecated: v2.30
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
          x-versiondeprecated: v2.30
        targetName:
          description: The name of the target for labeling predictions. Required for
            model type 'inference'. Specifying this value for a model type 'training'
            will result in an error.
          maxLength: 500
          nullable: true
          type: string
      type: object
    CustomModelVersionCreate:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this model version. At least
            one of "baseEnvironmentId" and "baseEnvironmentVersionId" must be provided.
            If both are specified, the version must belong to the environment.
          type: string
          x-versionadded: v2.22
        baseEnvironmentVersionId:
          description: 'The base environment version ID to use with this model version.
            At least one of "baseEnvironmentId" and "baseEnvironmentVersionId" must
            be provided. If both are specified, the version must belong to the environment.
            If not specified: in the case where the previous model versions exist,
            the value from the latest model version is inherited, otherwise, the latest
            successfully built version of the environment specified in "baseEnvironmentId"
            is used.'
          type: string
          x-versionadded: v2.29
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model. This setting is incompatible with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        file:
          description: 'A file with code for a custom task or a custom model. For
            each file supplied as form data, you must have a corresponding `filePath`
            supplied that shows the relative location of the file. For example, you
            have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`.
            When uploading these files, you would _also_ need to include two `filePath`
            fields of, `"main.py"` and `"helpers/helper.py"`. If the supplied `file`
            already exists at the supplied `filePath`, the old file is replaced by
            the new file.'
          format: binary
          type: string
        filePath:
          description: The local path of the file being uploaded. See the `file` field
            explanation for more details.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model version.
          x-versionadded: v2.31
        holdoutData:
          description: 'Holdout data configuration may be supplied for version.                 This
            functionality has to be explicitly enabled for the current model.                 See
            isTrainingDataForVersionsPermanentlyEnabled parameter for                 :http:post:`/api/v2/customModels/`                 and                 :http:patch:`/api/v2/customModels/(customModelId)/`                 '
          nullable: true
          type: string
          x-versionadded: '2.31'
        isMajorUpdate:
          default: 'true'
          description: If set to true, new major version will created, otherwise minor
            version will be created.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        keepTrainingHoldoutData:
          description: If the version should inherit training and holdout data from
            the previous version. Defaults to true.This field is only applicable if
            the model has training data for versions enabled. Otherwise the field
            value will be ignored.
          type: boolean
          x-versionadded: v2.30
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed. This setting is incompatible
            with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          nullable: true
          type: string
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: string
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          type: string
          x-versionadded: v2.26
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
        trainingData:
          description: 'Training data configuration may be supplied for version.                 This
            functionality has to be explicitly enabled for the current model.                 See
            isTrainingDataForVersionsPermanentlyEnabled parameter for                 :http:post:`/api/v2/customModels/`                 and                 :http:patch:`/api/v2/customModels/(customModelId)/`                 '
          nullable: true
          type: string
          x-versionadded: '2.31'
      required:
      - isMajorUpdate
      type: object
    CustomModelVersionCreateFromLatest:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this model version. At least
            one of "baseEnvironmentId" and "baseEnvironmentVersionId" must be provided.
            If both are specified, the version must belong to the environment.
          type: string
          x-versionadded: v2.22
        baseEnvironmentVersionId:
          description: 'The base environment version ID to use with this model version.
            At least one of "baseEnvironmentId" and "baseEnvironmentVersionId" must
            be provided. If both are specified, the version must belong to the environment.
            If not specified: in the case where the previous model versions exist,
            the value from the latest model version is inherited, otherwise, the latest
            successfully built version of the environment specified in "baseEnvironmentId"
            is used.'
          type: string
          x-versionadded: v2.29
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model. This setting is incompatible with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        file:
          description: 'A file with code for a custom task or a custom model. For
            each file supplied as form data, you must have a corresponding `filePath`
            supplied that shows the relative location of the file. For example, you
            have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`.
            When uploading these files, you would _also_ need to include two `filePath`
            fields of, `"main.py"` and `"helpers/helper.py"`. If the supplied `file`
            already exists at the supplied `filePath`, the old file is replaced by
            the new file.'
          format: binary
          type: string
        filePath:
          description: The local path of the file being uploaded. See the `file` field
            explanation for more details.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model version.
          x-versionadded: v2.31
        holdoutData:
          description: 'Holdout data configuration may be supplied for version.                 This
            functionality has to be explicitly enabled for the current model.                 See
            isTrainingDataForVersionsPermanentlyEnabled parameter for                 :http:post:`/api/v2/customModels/`                 and                 :http:patch:`/api/v2/customModels/(customModelId)/`                 '
          nullable: true
          type: string
          x-versionadded: '2.31'
        isMajorUpdate:
          default: 'true'
          description: If set to true, new major version will created, otherwise minor
            version will be created.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        keepTrainingHoldoutData:
          description: If the version should inherit training and holdout data from
            the previous version. Defaults to true.This field is only applicable if
            the model has training data for versions enabled. Otherwise the field
            value will be ignored.
          type: boolean
          x-versionadded: v2.30
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed. This setting is incompatible
            with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          nullable: true
          type: string
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: string
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          type: string
          x-versionadded: v2.26
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
        trainingData:
          description: 'Training data configuration may be supplied for version.                 This
            functionality has to be explicitly enabled for the current model.                 See
            isTrainingDataForVersionsPermanentlyEnabled parameter for                 :http:post:`/api/v2/customModels/`                 and                 :http:patch:`/api/v2/customModels/(customModelId)/`                 '
          nullable: true
          type: string
          x-versionadded: '2.31'
      required:
      - isMajorUpdate
      type: object
    CustomModelVersionCreateFromRepository:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this version.
          type: string
          x-versionadded: v2.22
        isMajorUpdate:
          default: true
          description: If set to true, new major version will created, otherwise minor
            version will be created.
          type: boolean
        keepTrainingHoldoutData:
          description: If the version should inherit training and holdout data from
            the previous version. Defaults to true.This field is only applicable if
            the model has training data for versions enabled. Otherwise the field
            value will be ignored.
          type: boolean
          x-versionadded: v2.30
        ref:
          description: Remote reference (branch, commit, etc). Latest, if not specified.
          type: string
        repositoryId:
          description: The ID of remote repository used to pull sources. This ID can
            be found using the /api/v2/remoteRepositories/ endpoint.
          type: string
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: object
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          items:
            $ref: '#/components/schemas/RequiredMetadataValue'
          type: array
          x-versionadded: v2.26
        sourcePath:
          description: A remote repository file path to be pulled into a custom model
            or custom task.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      required:
      - repositoryId
      type: object
    CustomModelVersionListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom model versions.
          items:
            $ref: '#/components/schemas/CustomModelVersionResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomModelVersionMetadataUpdate:
      properties:
        description:
          description: New description for the custom task or model.
          maxLength: 10000
          type: string
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model version.
          x-versionadded: v2.31
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          type: object
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          items:
            $ref: '#/components/schemas/RequiredMetadataValue'
          type: array
          x-versionadded: v2.26
      type: object
    CustomModelVersionResponse:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this model version.
          nullable: true
          type: string
          x-versionadded: v2.22
        baseEnvironmentVersionId:
          description: The base environment version to use with this model version.
          nullable: true
          type: string
          x-versionadded: v2.25
        created:
          description: ISO-8601 timestamp of when the model was created.
          type: string
        customModelId:
          description: the ID of the custom model.
          type: string
        dependencies:
          description: The parsed dependencies of the custom model version if the
            version has a valid requirements.txt file.
          items:
            $ref: '#/components/schemas/DependencyResponse'
          type: array
          x-versionadded: v2.22
        description:
          description: Description of a custom model version.
          nullable: true
          type: string
        desiredMemory:
          description: The amount of memory that is expected to be allocated by the
            custom model. This setting is incompatible with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model version.
          x-versionadded: v2.31
        holdoutData:
          $ref: '#/components/schemas/HoldoutDataResponse'
          description: Holdout data configuration.
          nullable: true
          x-versionadded: v2.30
        id:
          description: the ID of the custom model version created.
          type: string
        isFrozen:
          description: If the version is frozen and immutable (i.e. it is either deployed
            or has been edited, causing a newer version to be yielded).
          type: boolean
        items:
          description: List of file items.
          items:
            $ref: '#/components/schemas/DeprecatedCustomModelWorkspaceItemResponse'
          type: array
        label:
          description: A semantic version number of the major and minor version.
          type: string
        maximumMemory:
          description: The maximum memory that might be allocated by the custom-model.
            If exceeded, the custom-model will be killed. This setting is incompatible
            with setting the resourceBundleId.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          nullable: true
          type: string
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: object
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          items:
            $ref: '#/components/schemas/RequiredMetadataValue'
          type: array
          x-versionadded: v2.26
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          nullable: true
          type: boolean
          x-versionadded: v2.26
        resourceBundleId:
          description: 'A single identifier that represents a bundle of resources:
            Memory, CPU, GPU, etc. A list of available bundles can be obtained via
            the resource bundles endpoint.'
          nullable: true
          type: string
          x-versionadded: v2.33
        trainingData:
          $ref: '#/components/schemas/TrainingDataResponse'
          description: Training data configuration.
          nullable: true
          x-versionadded: v2.31
        versionMajor:
          description: The major version number, incremented on deployments or larger
            file changes.
          type: integer
        versionMinor:
          description: The minor version number, incremented on general file changes.
          type: integer
      required:
      - created
      - customModelId
      - description
      - id
      - isFrozen
      - items
      - label
      - versionMajor
      - versionMinor
      type: object
    CustomModelVersionShortResponse:
      properties:
        id:
          description: The ID of the custom model version.
          type: string
        label:
          description: User-friendly name of the model version.
          type: string
      required:
      - id
      - label
      type: object
    CustomTaskAccessControlListResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: List of the requested custom task access control entries.
          items:
            $ref: '#/components/schemas/CustomTaskAccessControlResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    CustomTaskAccessControlResponse:
      properties:
        canShare:
          description: Whether this user can share this custom task
          type: boolean
        role:
          description: This users role.
          type: string
        userId:
          description: This user's userId.
          type: string
        username:
          description: The username for this user's entry.
          type: string
      required:
      - canShare
      - role
      - userId
      - username
      type: object
    CustomTaskCopy:
      properties:
        customTaskId:
          description: ID of the custom task to copy.
          type: string
      required:
      - customTaskId
      type: object
    CustomTaskCreate:
      properties:
        calibratePredictions:
          default: 'True'
          description: Whether model predictions should be calibrated by DataRobot.Only
            applies to anomaly detection; we recommend this if you have not already
            included calibration in your model code.Calibration improves the probability
            estimates of a model, and modifies the predictions of non-probabilistic
            models to be interpretable as probabilities. This will facilitate comparison
            to DataRobot models, and give access to ROC curve insights on external
            data.
          type: boolean
        description:
          description: The user-friendly description of the task.
          maxLength: 10000
          type: string
        language:
          description: Programming language name in which task is written.
          maxLength: 500
          type: string
        maximumMemory:
          description: DEPRECATED! The maximum memory that might be allocated by the
            custom-model. If exceeded, the custom-model will be killed.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: 2.32.0
        name:
          description: The user-friendly name for the task.
          maxLength: 255
          type: string
        targetType:
          description: The target type of the custom task
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          type: string
      required:
      - name
      - targetType
      type: object
    CustomTaskListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom tasks.
          items:
            $ref: '#/components/schemas/CustomTaskResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomTaskResponse:
      properties:
        calibratePredictions:
          description: Determines whether or not predictions should be calibrated
            by DataRobot. Only applies to anomaly detection.
          type: boolean
        created:
          description: ISO-8601 timestamp of when the task was created.
          type: string
        createdBy:
          description: The username of the custom task creator.
          type: string
        customModelType:
          description: The type of custom task.
          enum:
          - training
          - inference
          type: string
          x-versiondeprecated: v2.25
        description:
          description: The description of the task.
          type: string
        id:
          description: The ID of the custom task.
          type: string
        language:
          description: The programming language used by the task.
          type: string
        latestVersion:
          $ref: '#/components/schemas/CustomTaskVersionResponse'
          description: The latest version for the custom task (if this field is empty
            the task is not ready for use).
          nullable: true
        maximumMemory:
          description: DEPRECATED! The maximum memory that might be allocated by the
            custom-model. If exceeded, the custom-model will be killed.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: 2.32.0
        name:
          description: The name of the task.
          type: string
        targetType:
          description: The target type of the custom task.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          type: string
        updated:
          description: ISO-8601 timestamp of when task was last updated.
          type: string
      required:
      - created
      - createdBy
      - customModelType
      - description
      - id
      - language
      - latestVersion
      - name
      - targetType
      - updated
      type: object
    CustomTaskUpdate:
      properties:
        description:
          description: The user-friendly description of the task.
          maxLength: 10000
          type: string
        language:
          description: Programming language name in which task is written.
          maxLength: 500
          type: string
        maximumMemory:
          description: DEPRECATED! The maximum memory that might be allocated by the
            custom-model. If exceeded, the custom-model will be killed.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: 2.32.0
        name:
          description: The user-friendly name for the task.
          maxLength: 255
          type: string
      type: object
    CustomTaskVersionCreate:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this custom task version.
          type: string
        file:
          description: 'A file with code for a custom task or a custom model. For
            each file supplied as form data, you must have a corresponding `filePath`
            supplied that shows the relative location of the file. For example, you
            have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`.
            When uploading these files, you would _also_ need to include two `filePath`
            fields of, `"main.py"` and `"helpers/helper.py"`. If the supplied `file`
            already exists at the supplied `filePath`, the old file is replaced by
            the new file.'
          format: binary
          type: string
        filePath:
          description: The local path of the file being uploaded. See the `file` field
            explanation for more details.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        isMajorUpdate:
          default: 'true'
          description: If set to true, new major version will created, otherwise minor
            version will be created.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        maximumMemory:
          description: DEPRECATED! The maximum memory that might be allocated by the
            custom-model. If exceeded, the custom-model will be killed.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: 2.32.0
        outboundNetworkPolicy:
          description: What kind of outbound network calls are allowed. If ISOLATED,
            then no outbound network calls are allowed.  If PUBLIC, then network calls
            are allowed to any public ip address.
          enum:
          - ISOLATED
          - PUBLIC
          type: string
          x-versionadded: 2.32.0
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: string
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          type: string
          x-versionadded: v2.26
      required:
      - baseEnvironmentId
      - isMajorUpdate
      type: object
    CustomTaskVersionCreateFromLatest:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this custom task version.
          type: string
        file:
          description: 'A file with code for a custom task or a custom model. For
            each file supplied as form data, you must have a corresponding `filePath`
            supplied that shows the relative location of the file. For example, you
            have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`.
            When uploading these files, you would _also_ need to include two `filePath`
            fields of, `"main.py"` and `"helpers/helper.py"`. If the supplied `file`
            already exists at the supplied `filePath`, the old file is replaced by
            the new file.'
          format: binary
          type: string
        filePath:
          description: The local path of the file being uploaded. See the `file` field
            explanation for more details.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        isMajorUpdate:
          default: 'true'
          description: If set to true, new major version will created, otherwise minor
            version will be created.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        maximumMemory:
          description: DEPRECATED! The maximum memory that might be allocated by the
            custom-model. If exceeded, the custom-model will be killed.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: 2.32.0
        outboundNetworkPolicy:
          description: What kind of outbound network calls are allowed. If ISOLATED,
            then no outbound network calls are allowed.  If PUBLIC, then network calls
            are allowed to any public ip address.
          enum:
          - ISOLATED
          - PUBLIC
          type: string
          x-versionadded: 2.32.0
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: string
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          type: string
          x-versionadded: v2.26
      required:
      - baseEnvironmentId
      - isMajorUpdate
      type: object
    CustomTaskVersionCreateFromRepository:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this version.
          type: string
          x-versionadded: v2.22
        isMajorUpdate:
          default: true
          description: If set to true, new major version will created, otherwise minor
            version will be created.
          type: boolean
        outboundNetworkPolicy:
          description: What kind of outbound network calls are allowed. If ISOLATED,
            then no outbound network calls are allowed.  If PUBLIC, then network calls
            are allowed to any public ip address.
          enum:
          - ISOLATED
          - PUBLIC
          type: string
          x-versionadded: 2.32.0
        ref:
          description: Remote reference (branch, commit, etc). Latest, if not specified.
          type: string
        repositoryId:
          description: The ID of remote repository used to pull sources. This ID can
            be found using the /api/v2/remoteRepositories/ endpoint.
          type: string
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you to change
            them, make a new version.
          type: object
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          items:
            $ref: '#/components/schemas/RequiredMetadataValue'
          type: array
          x-versionadded: v2.26
        sourcePath:
          description: A remote repository file path to be pulled into a custom model
            or custom task.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      required:
      - repositoryId
      type: object
    CustomTaskVersionDependencyBuildMetadataResponse:
      properties:
        buildEnd:
          description: The ISO-8601 encoded time when this build completed.
          nullable: true
          type: string
        buildLogLocation:
          description: The URL to download the build logs from this build.
          format: uri
          nullable: true
          type: string
        buildStart:
          description: The ISO-8601 encoded time when this build started.
          type: string
        buildStatus:
          description: The current status of the dependency build.
          enum:
          - submitted
          - processing
          - failed
          - success
          type: string
        customTaskId:
          description: The ID of custom task.
          type: string
        customTaskVersionId:
          description: The ID of custom task version.
          type: string
      required:
      - buildEnd
      - buildLogLocation
      - buildStart
      - buildStatus
      - customTaskId
      - customTaskVersionId
      type: object
    CustomTaskVersionListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of custom task versions.
          items:
            $ref: '#/components/schemas/CustomTaskVersionResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomTaskVersionMetadataUpdate:
      properties:
        description:
          description: New description for the custom task or model.
          maxLength: 10000
          type: string
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          type: object
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          items:
            $ref: '#/components/schemas/RequiredMetadataValue'
          type: array
          x-versionadded: v2.26
      type: object
    CustomTaskVersionResponse:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this task version.
          nullable: true
          type: string
        baseEnvironmentVersionId:
          description: The base environment version to use with this task version.
          nullable: true
          type: string
        created:
          description: ISO-8601 timestamp of when the task was created.
          type: string
        customModelId:
          description: an alias for customTaskId
          type: string
          x-versiondeprecated: v2.25
        customTaskId:
          description: the ID of the custom task.
          type: string
        dependencies:
          description: The parsed dependencies of the custom task version if the version
            has a valid requirements.txt file.
          items:
            $ref: '#/components/schemas/DependencyResponse'
          type: array
        description:
          description: Description of a custom task version.
          nullable: true
          type: string
        id:
          description: the ID of the custom model version created.
          type: string
        isFrozen:
          description: If the version is frozen and immutable (i.e. it is either deployed
            or has been edited, causing a newer version to be yielded).
          type: boolean
        items:
          description: List of file items.
          items:
            $ref: '#/components/schemas/WorkspaceItemResponse'
          type: array
        label:
          description: A semantic version number of the major and minor version.
          type: string
        maximumMemory:
          description: DEPRECATED! The maximum memory that might be allocated by the
            custom-model. If exceeded, the custom-model will be killed.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
          x-versiondeprecated: 2.32.0
        outboundNetworkPolicy:
          description: What kind of outbound network calls are allowed. If ISOLATED,
            then no outbound network calls are allowed.  If PUBLIC, then network calls
            are allowed to any public ip address.
          enum:
          - ISOLATED
          - PUBLIC
          type: string
          x-versionadded: 2.32.0
        requiredMetadata:
          description: Additional parameters required by the execution environment.
            The required keys are defined by the fieldNames in the base environment's
            requiredMetadataKeys. Once set, they cannot be changed. If you want to
            change them, make a new version.
          type: object
          x-versionadded: v2.25
          x-versiondeprecated: v2.26
        requiredMetadataValues:
          description: Additional parameters required by the execution environment.
            The required fieldNames are defined by the fieldNames in the base environment's
            requiredMetadataKeys.
          items:
            $ref: '#/components/schemas/RequiredMetadataValue'
          type: array
          x-versionadded: v2.26
        versionMajor:
          description: The major version number, incremented on deployments or larger
            file changes.
          type: integer
        versionMinor:
          description: The minor version number, incremented on general file changes.
          type: integer
        warning:
          description: Warnings about the custom task version
          items:
            type: string
          type: array
      required:
      - created
      - customModelId
      - customTaskId
      - description
      - id
      - isFrozen
      - items
      - label
      - outboundNetworkPolicy
      - versionMajor
      - versionMinor
      type: object
    CustomTrainingBlueprintCreate:
      properties:
        customModelVersionId:
          description: The ID of the specific model version from which to create a
            custom training blueprint.
          type: string
      required:
      - customModelVersionId
      type: object
    CustomTrainingBlueprintListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of training model blueprints.
          items:
            $ref: '#/components/schemas/CustomTrainingBlueprintResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomTrainingBlueprintResponse:
      properties:
        createdAt:
          description: ISO-8601 timestamp of when the blueprint was created.
          type: string
        customModel:
          $ref: '#/components/schemas/CustomModelShortResponse'
          description: Custom model in the image.
        customModelVersion:
          $ref: '#/components/schemas/CustomModelVersionShortResponse'
          description: Version of the model in the image.
        executionEnvironment:
          $ref: '#/components/schemas/ExecutionEnvironmentShortResponse'
          description: Execution environment in the image.
        executionEnvironmentVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionShortResponse'
          description: Version of the environment in the image.
        targetType:
          description: The target type of the training model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - Unstructured
          type: string
        trainingHistory:
          description: List of instances of this blueprint having been trained.
          items:
            $ref: '#/components/schemas/TrainingHistoryEntry'
          type: array
        userBlueprintId:
          description: User Blueprint ID that can be used to train the model.
          type: string
      required:
      - createdAt
      - customModel
      - customModelVersion
      - executionEnvironment
      - executionEnvironmentVersion
      - targetType
      - trainingHistory
      - userBlueprintId
      type: object
    CustomerHeader:
      properties:
        name:
          description: The name of the header.
          type: string
        value:
          description: The value of the header.
          type: string
      required:
      - name
      - value
      type: object
    DRConnectorV1Create:
      properties:
        connectorId:
          description: ID of the connector.
          type: string
        fields:
          description: Connector fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - connectorId
      - fields
      type: object
    DRConnectorV1DataSource:
      properties:
        dataStoreId:
          description: Data store ID for this data source.
          type: string
          x-versionadded: v2.22
        path:
          description: Path to the dataset within whatever filesystem data source
            is using. For example, for S3 the path will look something like `/foldername/filename.csv`.
          type: string
          x-versionadded: v2.22
      required:
      - dataStoreId
      - path
      type: object
    DRConnectorV1Details:
      properties:
        connectorId:
          description: ID of the connector.
          type: string
        fieldSchemas:
          description: Connector field schemas.
          items:
            $ref: '#/components/schemas/ConnectorFieldSchema'
          type: array
        fields:
          description: Connector fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - connectorId
      - fields
      type: object
    DRConnectorV1Field:
      properties:
        id:
          description: Field name.
          type: string
        name:
          description: User-friendly displayable field name.
          type: string
        value:
          description: Field value.
          type: string
      required:
      - name
      - value
      type: object
    DRConnectorV1Update:
      properties:
        fields:
          description: Connector fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      type: object
    DREntity:
      properties:
        id:
          description: The id of DataRobot entity.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the entity.
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      type: object
    DSS:
      properties:
        datasetId:
          description: The ID of the dataset
          type: string
        partition:
          default: null
          description: Partition used to predict
          enum:
          - holdout
          - validation
          - allBacktests
          - None
          type: string
        projectId:
          description: The ID of the project
          type: string
        type:
          description: Type name for this intake type
          enum:
          - dss
          type: string
      required:
      - projectId
      - type
      type: object
    DSSDataStreamer:
      properties:
        datasetId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the dataset
            type: string
          - enum:
            - '[redacted]'
            type: string
        partition:
          default: null
          description: Partition used to predict
          enum:
          - holdout
          - validation
          - allBacktests
          - None
          type: string
        projectId:
          description: The ID of the project
          type: string
        type:
          description: Type name for this intake type
          enum:
          - dss
          type: string
      required:
      - projectId
      - type
      type: object
    DataDisparityCreatePayload:
      properties:
        comparedClassNames:
          description: An array of classes to calculate data disparity for.
          items:
            type: string
          maxItems: 2
          minItems: 2
          type: array
        feature:
          description: Feature for which insight is computed.
          type: string
      required:
      - comparedClassNames
      - feature
      type: object
    DataDisparityCreateResponse:
      properties:
        statusId:
          description: The ID of the status object.
          type: string
      required:
      - statusId
      type: object
    DataDisparityInsights:
      properties:
        features:
          description: A mapping of the feature name to the corresponding values on
            the graph.
          items:
            $ref: '#/components/schemas/AnalyzedFeature'
          type: array
        metric:
          description: Metric used to calculate the impact of a feature on data disparity.
          type: string
        protectedFeature:
          description: Feature for which insights were computed.
          type: string
        values:
          description: Class count details for each class being compared.
          items:
            $ref: '#/components/schemas/FeatureCounts'
            description: Number of occurrences of each class being compared.
          type: array
      type: object
    DataDisparityRetrieveResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          $ref: '#/components/schemas/DataDisparityInsights'
          description: Computed data disparity insights if available.
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DataDriftHealth:
      properties:
        batchCount:
          description: Number of recent batches used to compute data drift health
            status, only applicable to deployments with batch monitoring enabled.
          enum:
          - '1'
          - '5'
          - '10'
          - '50'
          - '100'
          - '1000'
          - '10000'
          type: string
          x-versionadded: v2.33
        driftThreshold:
          description: The drift metric threshold above which the feature is considered
            as drifted.
          maximum: 1
          minimum: 0
          type: number
          x-versionadded: v2.33
        excludedFeatures:
          description: Features that are excluded from data drift status consideration.
          items:
            maxLength: 256
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.33
        highImportanceFailingCount:
          description: Threshold of drifted high importance feature count for failing
            status.
          minimum: 1
          nullable: true
          type: integer
          x-versionadded: v2.33
        highImportanceWarningCount:
          description: Threshold of drifted high importance feature count for warning
            status.
          minimum: 1
          nullable: true
          type: integer
          x-versionadded: v2.33
        importanceThreshold:
          description: The feature importance threshold above which the feature is
            considered as important.
          maximum: 1
          minimum: 0
          type: number
          x-versionadded: v2.33
        lowImportanceFailingCount:
          description: Threshold of drifted low importance feature count for failing
            status.
          minimum: 1
          nullable: true
          type: integer
          x-versionadded: v2.33
        lowImportanceWarningCount:
          description: Threshold of drifted low importance feature count for warning
            status.
          minimum: 1
          nullable: true
          type: integer
          x-versionadded: v2.33
        starredFeatures:
          description: Features that are deemed to be of high importance, regardless
            of how their feature importance values compare against the threshold.
          items:
            maxLength: 256
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.33
        timeInterval:
          description: Time duration used to compute data drift health status, only
            applicable to deployments with batch monitoring disabled.
          enum:
          - T2H
          - P1D
          - P7D
          - P30D
          - P90D
          - P180D
          - P365D
          - ALL
          type: string
          x-versionadded: v2.33
      type: object
    DataEngineDataset:
      properties:
        alias:
          description: Alias to be used as the table name.
          type: string
        datasetId:
          description: The ID of the dataset.
          type: string
        datasetVersionId:
          description: The ID of the dataset version.
          type: string
      required:
      - alias
      type: object
    DataPointResponse:
      properties:
        prediction:
          description: The output of the model for this row.
          type: number
        shapExplanation:
          description: Either ``null`` or an array of up to 10 `ShapleyFeatureContribution`
            objects. Only rows with the highest anomaly scores have Shapley explanations
            calculated.
          items:
            $ref: '#/components/schemas/ShapExplanationResponse'
          nullable: true
          type: array
        timestamp:
          description: ISO-formatted timestamp for the row.
          format: date-time
          type: string
      required:
      - prediction
      - shapExplanation
      - timestamp
      type: object
    DataQualityWarningsRecord:
      properties:
        hasKiaMissingValuesInForecastWindow:
          description: If true, known-in-advance features in this dataset have missing
            values in the forecast window. Absence of the known-in-advance values
            can negatively impact prediction quality. Only applies for time series
            projects.
          type: boolean
          x-versionadded: v2.15
        insufficientRowsForEvaluatingModels:
          description: If true, the dataset has a target column present indicating
            it can be used to evaluate model performance but too few rows to be trustworthy
            in so doing. If false, either it has no target column at all or it has
            sufficient rows for model evaluation. Only applies for regression, binary
            classification, multiclass classification projects and time series unsupervised
            projects.
          type: boolean
          x-versionadded: v2.19
        singleClassActualValueColumn:
          description: If true, actual value column has only one class and such insights
            as ROC curve can not be calculated. Only applies for binary classification
            projects or unsupervised projects.
          type: boolean
          x-versionadded: v2.21
      type: object
    DataSliceComputeSubsetSizeRequest:
      properties:
        externalDatasetId:
          description: The external dataset ID to use when calculating the size of
            a slice. Use this parameter only when the source is 'externalTestSet'.
          nullable: true
          type: string
        modelId:
          description: The model ID whose training dataset should be sliced. Use this
            parameter only when the source is 'training'.
          nullable: true
          type: string
        projectId:
          description: The project ID.
          type: string
        source:
          description: The source of data to use to calculate the size.
          enum:
          - backtest_0
          - backtest_0_training
          - backtest_1
          - backtest_10
          - backtest_10_training
          - backtest_11
          - backtest_11_training
          - backtest_12
          - backtest_12_training
          - backtest_13
          - backtest_13_training
          - backtest_14
          - backtest_14_training
          - backtest_15
          - backtest_15_training
          - backtest_16
          - backtest_16_training
          - backtest_17
          - backtest_17_training
          - backtest_18
          - backtest_18_training
          - backtest_19
          - backtest_19_training
          - backtest_1_training
          - backtest_2
          - backtest_20
          - backtest_20_training
          - backtest_2_training
          - backtest_3
          - backtest_3_training
          - backtest_4
          - backtest_4_training
          - backtest_5
          - backtest_5_training
          - backtest_6
          - backtest_6_training
          - backtest_7
          - backtest_7_training
          - backtest_8
          - backtest_8_training
          - backtest_9
          - backtest_9_training
          - crossValidation
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
      required:
      - projectId
      - source
      type: object
    DataSliceIndividualResponse:
      properties:
        filters:
          description: List of filters the data slice is composed of.
          items:
            $ref: '#/components/schemas/FilterDataSlices'
          maxItems: 3
          minItems: 1
          type: array
        id:
          description: ID of the data slice.
          type: string
        name:
          description: User provided name for the data slice.
          maxLength: 500
          minLength: 1
          type: string
        projectId:
          description: The project ID.
          type: string
      required:
      - filters
      - id
      - name
      - projectId
      type: object
    DataSliceMessage:
      properties:
        additionalInfo:
          description: Additional details about this message.
          type: string
        description:
          description: Short summary description about this message.
          type: string
        level:
          description: Message level.
          enum:
          - CRITICAL
          - INFORMATIONAL
          - WARNING
          type: string
      required:
      - additionalInfo
      - description
      - level
      type: object
    DataSliceRetrieveSubsetSizeResponse:
      properties:
        dataSliceId:
          description: ID of the data slice.
          type: string
        externalDatasetId:
          description: The external dataset ID to use when calculating the size of
            a slice. Use this parameter only when the source is 'externalTestSet'.
          nullable: true
          type: string
        messages:
          description: List of user-relevant messages related to a Data Slice.
          items:
            $ref: '#/components/schemas/DataSliceMessage'
          maxItems: 100
          type: array
        modelId:
          description: The model ID whose training dataset should be sliced. Use this
            parameter only when the source is 'training'.
          nullable: true
          type: string
        projectId:
          description: The project ID.
          type: string
        sliceSize:
          description: Number of rows in the slice for the given source.
          minimum: 0
          type: integer
        source:
          description: The source of data to use to calculate the size.
          enum:
          - backtest_0
          - backtest_0_training
          - backtest_1
          - backtest_10
          - backtest_10_training
          - backtest_11
          - backtest_11_training
          - backtest_12
          - backtest_12_training
          - backtest_13
          - backtest_13_training
          - backtest_14
          - backtest_14_training
          - backtest_15
          - backtest_15_training
          - backtest_16
          - backtest_16_training
          - backtest_17
          - backtest_17_training
          - backtest_18
          - backtest_18_training
          - backtest_19
          - backtest_19_training
          - backtest_1_training
          - backtest_2
          - backtest_20
          - backtest_20_training
          - backtest_2_training
          - backtest_3
          - backtest_3_training
          - backtest_4
          - backtest_4_training
          - backtest_5
          - backtest_5_training
          - backtest_6
          - backtest_6_training
          - backtest_7
          - backtest_7_training
          - backtest_8
          - backtest_8_training
          - backtest_9
          - backtest_9_training
          - crossValidation
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
      required:
      - dataSliceId
      - messages
      - projectId
      - sliceSize
      - source
      type: object
    DataSlicesBulkDeleteRequest:
      properties:
        ids:
          description: List of data slices to remove.
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
      required:
      - ids
      type: object
    DataSlicesCreationRequest:
      properties:
        filters:
          description: List of filters the data slice is composed of.
          items:
            $ref: '#/components/schemas/FilterDataSlices'
          maxItems: 3
          minItems: 1
          type: array
        name:
          description: User provided name for the data slice.
          maxLength: 500
          minLength: 1
          type: string
        projectId:
          description: The project ID.
          type: string
      required:
      - filters
      - name
      - projectId
      type: object
    DataSlicesListAllSlicesResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of paginated Data Slices.
          items:
            $ref: '#/components/schemas/DataSliceIndividualResponse'
          maxItems: 100
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DataSource:
      properties:
        catalog:
          description: Catalog name of the data source.
          nullable: true
          type: string
        dataSourceId:
          description: ID of the data source.
          type: string
        dataStoreId:
          description: ID of the data store.
          type: string
        dataStoreName:
          description: Name of the data store.
          type: string
        dbtable:
          description: Table name of the data source.
          type: string
        schema:
          description: Schema name of the data source.
          nullable: true
          type: string
        url:
          description: URL of the data store.
          type: string
      required:
      - dataStoreId
      - dataStoreName
      - dbtable
      - schema
      - url
      type: object
    DataSourceCreate:
      properties:
        canonicalName:
          description: Data source canonical name.
          type: string
        params:
          description: Data source configuration.
          oneOf:
          - $ref: '#/components/schemas/DatabaseTableDataSource'
          - $ref: '#/components/schemas/DatabaseQueryDataSource'
          - $ref: '#/components/schemas/DRConnectorV1DataSource'
        type:
          description: Data source type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
      required:
      - canonicalName
      - params
      - type
      type: object
    DataSourceDescribePermissionsResponse:
      properties:
        canCreatePredictions:
          description: True if the user can create predictions from the data source.
          type: boolean
        canCreateProject:
          description: True if the user can create project from the data source.
          type: boolean
        canDelete:
          description: True if the user can delete the data source.
          type: boolean
        canEdit:
          description: True if the user can edit data source info.
          type: boolean
        canSetRoles:
          description: Roles the user can grant or revoke from other users, groups,
            or organizations.
          items:
            description: The role the user can grant or revoke from users, groups
              or organizations.
            enum:
            - OWNER
            - EDITOR
            - CONSUMER
            type: string
          type: array
        canShare:
          description: True if the user can share the data source.
          type: boolean
        canView:
          description: True if the user can view data source info.
          type: boolean
        dataSourceId:
          description: The ID of the data source.
          type: string
        userId:
          description: The ID of the user identified by username.
          type: string
        username:
          description: '`username` of a user with access to this data source.'
          type: string
      required:
      - canCreatePredictions
      - canCreateProject
      - canDelete
      - canEdit
      - canSetRoles
      - canShare
      - canView
      - dataSourceId
      - userId
      - username
      type: object
    DataSourceInList:
      properties:
        canDelete:
          description: True if the user can delete the data source.
          type: boolean
          x-versionadded: v2.23
        canShare:
          description: True if the user can share the data source.
          type: boolean
          x-versionadded: v2.22
        canonicalName:
          description: Data source canonical name.
          type: string
        creator:
          description: ID of the user who created the data source.
          type: string
        driverClassType:
          description: The type of driver used to create this data source.
          type: string
        id:
          description: Data source ID.
          type: string
        params:
          description: Data source configuration.
          oneOf:
          - $ref: '#/components/schemas/DatabaseTableDataSource'
          - $ref: '#/components/schemas/DatabaseQueryDataSource'
          - $ref: '#/components/schemas/DRConnectorV1DataSource'
        role:
          description: Role of the user making the request on this data source.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        type:
          description: Data source type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        updated:
          description: ISO 8601-formatted date/time of the data source update.
          type: string
      required:
      - canDelete
      - canShare
      - canonicalName
      - creator
      - id
      - params
      - role
      - type
      - updated
      type: object
    DataSourceListResponse:
      properties:
        data:
          description: List of data sources.
          items:
            $ref: '#/components/schemas/DataSourceInList'
          type: array
      required:
      - data
      type: object
    DataSourceRetrieveResponse:
      properties:
        canonicalName:
          description: Data source canonical name.
          type: string
        creator:
          description: ID of the user who created the data source.
          type: string
        driverClassType:
          description: The type of driver used to create this data source.
          type: string
        id:
          description: Data source ID.
          type: string
        params:
          description: Data source configuration.
          oneOf:
          - $ref: '#/components/schemas/DatabaseTableDataSource'
          - $ref: '#/components/schemas/DatabaseQueryDataSource'
          - $ref: '#/components/schemas/DRConnectorV1DataSource'
        role:
          description: Role of the user making the request on this data source.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        type:
          description: Data source type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        updated:
          description: ISO 8601-formatted date/time of the data source update.
          type: string
      required:
      - canonicalName
      - creator
      - id
      - params
      - role
      - type
      - updated
      type: object
    DataSourceUpdate:
      properties:
        canonicalName:
          description: Data source canonical name.
          type: string
        params:
          description: Data source configuration.
          oneOf:
          - $ref: '#/components/schemas/OptionalDatabaseTableDataSource'
          - $ref: '#/components/schemas/OptionalDatabaseQueryDataSource'
          - $ref: '#/components/schemas/OptionalDRConnectorV1DataSource'
      type: object
    DataStageDataStreamer:
      properties:
        dataStageId:
          description: The ID of the data stage
          type: string
        type:
          description: Type name for this intake type
          enum:
          - dataStage
          type: string
      required:
      - dataStageId
      - type
      type: object
    DataStageIntake:
      properties:
        dataStageId:
          description: The ID of the data stage
          type: string
        type:
          description: Type name for this intake type
          enum:
          - dataStage
          type: string
      required:
      - dataStageId
      - type
      type: object
    DataStoreColumnResponse:
      properties:
        dataType:
          description: DataType of the column.
          type: string
        name:
          description: Name of the column.
          type: string
        precision:
          description: Precision of the column.
          type: string
        scale:
          description: Scale of the column.
          type: string
      required:
      - dataType
      - name
      - precision
      - scale
      type: object
    DataStoreColumnsInfoList:
      properties:
        catalog:
          description: Name of specified database catalog.
          nullable: true
          type: string
        credentialId:
          description: ID of the set of credentials to use instead of username and
            password.
          type: string
          x-versionadded: v2.19
        password:
          description: Password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        schema:
          description: Schema name.
          type: string
        table:
          description: Table name.
          type: string
        useKerberos:
          default: false
          description: Whether to use Kerberos for data store authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: Username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      required:
      - table
      type: object
    DataStoreColumnsInfoListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of data store columns meta data.
          items:
            $ref: '#/components/schemas/DataStoreExtendedColumnResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DataStoreColumnsList:
      properties:
        catalog:
          description: Name of specified database catalog.
          nullable: true
          type: string
        credentialId:
          description: Id of credential mapping.
          type: string
        password:
          description: Password for the db connection.
          type: string
        query:
          description: Schema query.
          type: string
        schema:
          description: Schema name.
          type: string
        table:
          description: Table name.
          type: string
        user:
          description: Username for the db connection.
          type: string
      type: object
    DataStoreColumnsListResponse:
      properties:
        columns:
          description: List of data store columns.
          items:
            $ref: '#/components/schemas/DataStoreColumnResponse'
          type: array
      required:
      - columns
      type: object
    DataStoreCreate:
      properties:
        canonicalName:
          description: The user-friendly name of the data store.
          type: string
        params:
          description: Data store configuration.
          oneOf:
          - $ref: '#/components/schemas/JDBCDataStoreCreate'
          - $ref: '#/components/schemas/DRConnectorV1Create'
          - $ref: '#/components/schemas/DatabaseDataStoreCreate'
        type:
          description: Data store type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
      required:
      - canonicalName
      - params
      - type
      type: object
    DataStoreCredentials:
      properties:
        credentialId:
          description: ID of the set of credentials to use instead of username and
            password.
          type: string
          x-versionadded: v2.19
        password:
          description: Password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        useKerberos:
          default: false
          description: Whether to use Kerberos for data store authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: Username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      type: object
    DataStoreCredentialsWithCredentialsTypeSupport:
      properties:
        credentialData:
          description: Type of credentials to use with the data store.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentials'
          - $ref: '#/components/schemas/GoogleServiceAccountCredentials'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentials'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentials'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentials'
          x-versionadded: v2.23
        credentialId:
          description: ID of the set of credentials to use instead of username and
            password.
          type: string
          x-versionadded: v2.19
        password:
          description: Password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        useKerberos:
          default: false
          description: Whether to use Kerberos for data store authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: Username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      type: object
    DataStoreDescribePermissionsResponse:
      properties:
        canCreateDataSource:
          description: True if the user can create data source from this data store.
          type: boolean
        canDelete:
          description: True if the user can delete the data store.
          type: boolean
        canEdit:
          description: True if the user can edit data store info.
          type: boolean
        canScanDatabase:
          description: True if the user can scan data store database.
          type: boolean
        canSetRoles:
          description: Roles the user can grant or revoke from other users, groups,
            or organizations.
          items:
            description: The role the user can grant or revoke from users, groups
              or organizations.
            enum:
            - OWNER
            - EDITOR
            - CONSUMER
            type: string
          type: array
        canShare:
          description: True if the user can share the data store.
          type: boolean
        canTestConnection:
          description: True if the user can test data store database connection.
          type: boolean
        canView:
          description: True if the user can view data store info.
          type: boolean
        dataStoreId:
          description: The ID of the data store.
          type: string
        userId:
          description: The ID of the user identified by username.
          type: string
        username:
          description: '`username` of a user with access to this data store.'
          type: string
      required:
      - canCreateDataSource
      - canDelete
      - canEdit
      - canScanDatabase
      - canSetRoles
      - canShare
      - canTestConnection
      - canView
      - dataStoreId
      - userId
      - username
      type: object
    DataStoreExtendedColumnNoKeysResponse:
      properties:
        columnDefaultValue:
          description: Default value of the column.
          nullable: true
          type: string
          x-versionadded: v2.33
        dataType:
          description: DataType of the column.
          type: string
          x-versionadded: v2.33
        dataTypeInt:
          description: Integer value of the column data type.
          type: integer
          x-versionadded: v2.33
        isInPrimaryKey:
          description: True if the column is in the primary key .
          type: boolean
          x-versionadded: v2.33
        isNullable:
          description: If the column values can be null.
          enum:
          - 'NO'
          - UNKNOWN
          - 'YES'
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: Name of the column.
          type: string
          x-versionadded: v2.33
        precision:
          description: Precision of the column.
          type: integer
          x-versionadded: v2.33
        scale:
          description: Scale of the column.
          type: integer
          x-versionadded: v2.33
      required:
      - dataType
      - name
      type: object
    DataStoreExtendedColumnResponse:
      properties:
        columnDefaultValue:
          description: Default value of the column.
          nullable: true
          type: string
        comment:
          description: Comment of the column.
          nullable: true
          type: string
        dataType:
          description: DataType of the column.
          type: string
        dataTypeInt:
          description: Integer value of the column data type.
          type: integer
        exportedKeys:
          description: The foreign key columns that reference this table's primary
            key columns.
          items:
            $ref: '#/components/schemas/JdbcForeignKey'
          type: array
        importedKeys:
          description: The primary key columns that are referenced by this table's
            foreign key columns .
          items:
            $ref: '#/components/schemas/JdbcForeignKey'
          type: array
        isInPrimaryKey:
          description: True if the column is in the primary key .
          type: boolean
        isNullable:
          description: If the column values can be null.
          enum:
          - 'NO'
          - UNKNOWN
          - 'YES'
          nullable: true
          type: string
        name:
          description: Name of the column.
          type: string
        precision:
          description: Precision of the column.
          type: integer
        primaryKeys:
          description: Primary key columns of the table.
          items:
            type: string
          type: array
        scale:
          description: Scale of the column.
          type: integer
      required:
      - columnDefaultValue
      - comment
      - dataType
      - dataTypeInt
      - exportedKeys
      - importedKeys
      - isInPrimaryKey
      - isNullable
      - name
      - precision
      - primaryKeys
      - scale
      type: object
    DataStoreListResponse:
      properties:
        data:
          description: List of data stores.
          items:
            $ref: '#/components/schemas/DataStoreRetrieveResponse'
          type: array
      required:
      - data
      type: object
    DataStoreRetrieveResponse:
      properties:
        associatedAuthTypes:
          description: Supported authentication types for the JDBC configuration.
          items:
            enum:
            - adls_gen2_oauth
            - azure_service_principal
            - basic
            - databricks_access_token_account
            - databricks_service_principal_account
            - gcp
            - google_oauth_user_account
            - kerberos
            - oauth
            - s3
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            type: string
          type: array
          x-versionadded: v2.20
        canonicalName:
          description: The user-friendly name of the data store.
          type: string
        creator:
          description: ID of the user who created the data store.
          type: string
        id:
          description: Data store ID.
          type: string
        params:
          description: Data store configuration.
          oneOf:
          - $ref: '#/components/schemas/JDBCDataStoreDetails'
          - $ref: '#/components/schemas/DRConnectorV1Details'
          - $ref: '#/components/schemas/DatabaseDataStoreDetails'
        role:
          description: Role of the user making the request on this data store.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        type:
          description: Data store type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        updated:
          description: ISO 8601-formatted date/time of the data store update.
          type: string
      required:
      - canonicalName
      - creator
      - id
      - params
      - role
      - type
      - updated
      type: object
    DataStoreSQLVerify:
      properties:
        credentialId:
          description: ID of the set of credentials to use instead of username and
            password.
          type: string
          x-versionadded: v2.19
        maxRows:
          description: Maximum number of rows of data to return if successful.
          maximum: 999
          minimum: 0
          type: integer
        password:
          description: Password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        query:
          description: SQL query to verify.
          type: string
        useKerberos:
          default: false
          description: Whether to use Kerberos for data store authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: Username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      required:
      - maxRows
      - query
      type: object
    DataStoreSQLVerifyResponse:
      properties:
        columns:
          description: List of columns for the returned set of records. Column order
            matches the order of values in a record.
          items:
            description: Name of the column.
            type: string
          type: array
        records:
          description: List of records output by the query.
          items:
            description: List of values for a single database record, ordered as the
              columns are ordered.
            items:
              description: String representation of the column's value.
              type: string
            type: array
          type: array
      required:
      - columns
      - records
      type: object
    DataStoreSchemasList:
      properties:
        catalog:
          description: Name of the catalog associated with the schemas. If more than
            one catalog is queried, the returned value will be the catalog name for
            the first record returned.
          type: string
        catalogs:
          description: List of catalogs associated with each retrieved schema. If
            no catalog is found, this value is null.
          items:
            description: Catalog names for the schema associated with the data store.
            type: string
          type: array
        schemas:
          description: List of schemas available in the data store.
          items:
            type: string
          type: array
      required:
      - catalog
      - catalogs
      - schemas
      type: object
    DataStoreTables:
      properties:
        catalog:
          description: Only show tables in this catalog.
          type: string
        credentialId:
          description: ID of the set of credentials to use instead of username and
            password.
          type: string
          x-versionadded: v2.19
        password:
          description: Password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        schema:
          description: Only show tables in this schema.
          type: string
        useKerberos:
          default: false
          description: Whether to use Kerberos for data store authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: Username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      type: object
    DataStoreTablesList:
      properties:
        catalog:
          description: Catalog associated with schemas.
          type: string
        tables:
          description: List of tables in the data store.
          items:
            $ref: '#/components/schemas/TableDescription'
          type: array
      required:
      - catalog
      - tables
      type: object
    DataStoreTestResponse:
      properties:
        message:
          description: Connection attempt results.
          type: string
      required:
      - message
      type: object
    DataStoreUpdate:
      properties:
        canonicalName:
          description: The user-friendly name of the data store.
          type: string
        params:
          description: Data store configuration.
          oneOf:
          - $ref: '#/components/schemas/JDBCDataStoreUpdate'
          - $ref: '#/components/schemas/DRConnectorV1Update'
      type: object
    DatabaseDataStoreCreate:
      properties:
        driverId:
          description: Database Driver ID.
          type: string
        fields:
          description: Database driver fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - driverId
      - fields
      type: object
    DatabaseDataStoreDetails:
      properties:
        driverId:
          description: Database Driver ID.
          type: string
        fieldSchemas:
          description: Database driver field schemas.
          items:
            $ref: '#/components/schemas/ConnectorFieldSchema'
          type: array
        fields:
          description: Database driver fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - driverId
      - fields
      type: object
    DatabaseQueryDataSource:
      properties:
        dataStoreId:
          description: Data store ID for this data source.
          type: string
        fetchSize:
          description: User-specified fetch size.
          maximum: 20000
          minimum: 1
          type: integer
        query:
          description: The user-specified SQL query. If this is used, then catalog,
            schema and table will not be used.
          maxLength: 64000
          type: string
      required:
      - dataStoreId
      - query
      type: object
    DatabaseTableDataSource:
      properties:
        catalog:
          description: Catalog name in the database if supported.
          maxLength: 256
          type: string
        dataStoreId:
          description: Data store ID for this data source.
          type: string
        fetchSize:
          description: User-specified fetch size.
          maximum: 20000
          minimum: 1
          type: integer
        partitionColumn:
          description: The name of the partition column. It is needed to allow parallel
            execution for the 10GB+ projects.
          type: string
        schema:
          description: Schema associated with the table or view in the database if
            the data source is not query based.
          maxLength: 256
          type: string
        table:
          description: Table or view name in the database if the data source is not
            query based.
          maxLength: 256
          type: string
      required:
      - dataStoreId
      - table
      type: object
    DatabricksAccessTokenCredentials:
      properties:
        credentialType:
          description: The type of these credentials, 'databricks_access_token_account'
            here.
          enum:
          - databricks_access_token_account
          type: string
        databricksAccessToken:
          description: Databricks personal access token.
          minLength: 1
          type: string
      required:
      - credentialType
      - databricksAccessToken
      type: object
    DatabricksServicePrincipalCredentials:
      properties:
        clientId:
          description: Client ID for Databricks service principal.
          minLength: 1
          type: string
        clientSecret:
          description: Client secret for Databricks service principal.
          minLength: 1
          type: string
        configId:
          description: The ID of the saved shared credentials. If specified, cannot
            include clientIdand clientSecret.
          type: string
        credentialType:
          description: The type of these credentials, 'databricks_service_principal_account'
            here.
          enum:
          - databricks_service_principal_account
          type: string
      required:
      - credentialType
      type: object
    Dataset:
      properties:
        id:
          description: ID of the retraining dataset.
          type: string
        name:
          description: Name of the retraining dataset.
          type: string
      required:
      - id
      - name
      type: object
    DatasetAccessControlListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of DatasetAccessControl objects.
          items:
            $ref: '#/components/schemas/DatasetAccessControlResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetAccessControlResponse:
      properties:
        canShare:
          description: True if this user can share with other users
          type: boolean
        canUseData:
          description: True if the user can view, download and process data (use to
            create projects, predictions, etc)
          type: boolean
        role:
          description: The role of the user on this data source.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          type: string
        userFullName:
          description: The full name of a user with access to this dataset. If the
            full name is not available, username is returned instead.
          type: string
        username:
          description: '`username` of a user with access to this dataset.'
          type: string
      required:
      - canShare
      - canUseData
      - role
      - userFullName
      - username
      type: object
    DatasetAccessInner:
      properties:
        canShare:
          description: whether the user should be able to share with other users.
            If true, the user will be able to grant any role up to and including their
            own to other users. If `role` is empty `canShare` is ignored.
          type: boolean
        canUseData:
          description: Whether the user should be able to view, download and process
            data (use to create projects, predictions, etc). For OWNER `canUseData`
            is always True. If `role` is empty `canUseData` is ignored.
          type: boolean
        role:
          description: the role to grant to the user, or "" (empty string) to remove
            the users access
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - ''
          type: string
        username:
          description: username of the user to update the access role for.
          type: string
      required:
      - role
      - username
      type: object
    DatasetAccessSet:
      properties:
        applyGrantToLinkedObjects:
          default: false
          description: If true for any users being granted access to the dataset,
            grant the user read access to any linked objects such as DataSources and
            DataStores that may be used by this dataset. Ignored if no such objects
            are relevant for dataset. Will not result in access being lowered for
            a user if the user already has higher access to linked objects than read
            access. However, if the target user does not have sharing permissions
            to the linked object, they will be given sharing access without lowering
            existing permissions. May result in an error if user making call does
            not have sufficient permissions to complete grant. Default value is false.
          type: boolean
        data:
          description: array of DatasetAccessControl objects.
          items:
            $ref: '#/components/schemas/DatasetAccessInner'
          minItems: 1
          type: array
      required:
      - data
      type: object
    DatasetCreateFromWorkspaceState:
      properties:
        credentials:
          description: JDBC credentials.
          type: string
        datasetName:
          description: Custom name for the created dataset.
          type: string
        doSnapshot:
          description: If true, create a snapshot dataset; if false, create a remote
            dataset. Creating snapshots from non-file sources requires an additional
            permission, `Enable Create Snapshot Data Source`.
          type: boolean
        workspaceStateId:
          description: ID of the workspace state to use as the source of data.
          type: string
      required:
      - workspaceStateId
      type: object
    DatasetDefinition:
      properties:
        catalogId:
          description: ID of the catalog item.
          type: string
        catalogVersionId:
          description: ID of the catalog item version.
          type: string
        featureListId:
          description: ID of the feature list. This decides which columns in the dataset
            are used for feature generation.
          nullable: true
          type: string
        identifier:
          description: Short name of the dataset (used directly as part of the generated
            feature names).
          maxLength: 20
          minLength: 1
          type: string
        primaryTemporalKey:
          description: Name of the column indicating time of record creation.
          nullable: true
          type: string
        snapshotPolicy:
          description: 'Policy for using dataset snapshots when creating a project
            or making predictions. Must be one of the following values: ''specified'':
            Use specific snapshot specified by catalogVersionId. ''latest'': Use latest
            snapshot from the same catalog item. ''dynamic'': Get data from the source
            (only applicable for JDBC datasets).'
          enum:
          - specified
          - latest
          - dynamic
          type: string
      required:
      - catalogId
      - catalogVersionId
      - identifier
      type: object
    DatasetDefinitionResponse:
      properties:
        catalogId:
          description: ID of the catalog item.
          nullable: true
          type: string
        catalogVersionId:
          description: ID of the catalog item version.
          type: string
        dataSource:
          $ref: '#/components/schemas/DataSource'
          description: Data source details for a JDBC dataset
          nullable: true
        dataSources:
          description: Data source details for a JDBC dataset
          items:
            $ref: '#/components/schemas/DataSource'
          nullable: true
          type: array
        featureListId:
          description: ID of the feature list. This decides which columns in the dataset
            are used for feature generation.
          type: string
        featureLists:
          description: List of available feature list ids for the dataset
          items:
            type: string
          type: array
        identifier:
          description: Short name of the dataset (used directly as part of the generated
            feature names).
          maxLength: 20
          minLength: 1
          type: string
        isDeleted:
          description: Is this dataset deleted?
          nullable: true
          type: boolean
        originalIdentifier:
          description: Original identifier of the dataset if it was updated to resolve
            name conflicts.
          maxLength: 20
          minLength: 1
          nullable: true
          type: string
        primaryTemporalKey:
          description: Name of the column indicating time of record creation.
          nullable: true
          type: string
        snapshotPolicy:
          description: 'Policy for using dataset snapshots when creating a project
            or making predictions. Must be one of the following values: ''specified'':
            Use specific snapshot specified by catalogVersionId. ''latest'': Use latest
            snapshot from the same catalog item. ''dynamic'': Get data from the source
            (only applicable for JDBC datasets).'
          enum:
          - specified
          - latest
          - dynamic
          type: string
      required:
      - catalogId
      - catalogVersionId
      - featureListId
      - identifier
      - snapshotPolicy
      type: object
    DatasetDescribePermissionsResponse:
      properties:
        canCreateFeaturelist:
          description: True if the user can create a new featurelist for this dataset.
          type: boolean
        canDeleteDataset:
          description: True if the user can delete dataset.
          type: boolean
        canDownloadDatasetData:
          description: True if the user can download data.
          type: boolean
        canGetCatalogItemInfo:
          description: True if the user can view catalog info.
          type: boolean
        canGetDatasetInfo:
          description: True if the user can view dataset info.
          type: boolean
        canGetDatasetPermissions:
          description: True if the user can view dataset permissions.
          type: boolean
        canGetFeatureInfo:
          description: True if the user can retrieve feature info of dataset.
          type: boolean
        canGetFeaturelists:
          description: True if the user can view featurelist for this dataset.
          type: boolean
        canPatchCatalogInfo:
          description: True if the user can modify catalog info.
          type: boolean
        canPatchDatasetAliases:
          description: True if the user can modify dataset feature aliases.
          type: boolean
        canPatchDatasetInfo:
          description: True if the user can modify dataset info.
          type: boolean
        canPatchDatasetPermissions:
          description: True if the user can modify dataset permissions.
          type: boolean
        canPatchFeaturelists:
          description: True if the user can modify featurelists for this dataset.
          type: boolean
        canPostDataset:
          description: True if the user can create a new dataset.
          type: boolean
        canReloadDataset:
          description: True if the user can reload dataset.
          type: boolean
        canShareDataset:
          description: True if the user can share the dataset.
          type: boolean
        canSnapshotDataset:
          description: True if the user can save snapshot of dataset.
          type: boolean
        canUndeleteDataset:
          description: True if the user can undelete dataset.
          type: boolean
        canUseDatasetData:
          description: True if the user can use dataset data to create projects, train
            custom models or provide predictions.
          type: boolean
        canUseFeaturelists:
          description: True if the user can use featurelists for this dataset. (for
            project creation)
          type: boolean
        datasetId:
          description: The ID of the dataset.
          type: string
        uid:
          description: The ID of the user identified by username.
          type: string
        username:
          description: '`username` of a user with access to this dataset.'
          type: string
      required:
      - canCreateFeaturelist
      - canDeleteDataset
      - canDownloadDatasetData
      - canGetCatalogItemInfo
      - canGetDatasetInfo
      - canGetDatasetPermissions
      - canGetFeatureInfo
      - canGetFeaturelists
      - canPatchCatalogInfo
      - canPatchDatasetAliases
      - canPatchDatasetInfo
      - canPatchDatasetPermissions
      - canPatchFeaturelists
      - canPostDataset
      - canReloadDataset
      - canShareDataset
      - canSnapshotDataset
      - canUndeleteDataset
      - canUseDatasetData
      - canUseFeaturelists
      - datasetId
      - uid
      - username
      type: object
    DatasetFeatureHistogramResponse:
      properties:
        plot:
          description: Plot data based on feature values.
          items:
            $ref: '#/components/schemas/DatasetFeaturePlotDataResponse'
          type: array
      required:
      - plot
      type: object
    DatasetFeaturePlotDataResponse:
      properties:
        count:
          description: Number of values in the bin.
          type: number
        label:
          description: Bin start for numerical/uncapped, or string value for categorical.
            The bin `==Missing==` is created for rows that did not have the feature.
          type: string
      required:
      - count
      - label
      type: object
    DatasetFeatureResponse:
      properties:
        datasetId:
          description: The ID of the dataset the feature belongs to
          type: string
        datasetVersionId:
          description: The ID of the dataset version the feature belongs to.
          type: string
        dateFormat:
          description: The date format string for how this feature was interpreted
            (or null if not a date feature). If not null, it will be compatible with
            https://docs.python.org/2/library/time.html#time.strftime .
          nullable: true
          type: string
        featureType:
          description: Feature type.
          enum:
          - Boolean
          - Categorical
          - Currency
          - Date
          - Date Duration
          - Document
          - Image
          - Interaction
          - Length
          - Location
          - Multicategorical
          - Numeric
          - Percentage
          - Summarized Categorical
          - Text
          - Time
          type: string
        id:
          description: The number of the column in the dataset.
          type: integer
        isZeroInflated:
          description: whether feature has an excessive number of zeros
          nullable: true
          type: boolean
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            description: For a Summarized Categorical columns, this will contain statistics
              for the top 50 keys (truncated to 103 characters)
            x-versionadded: v2.18
          - description: For a Multicategorical columns, this will contain statistics
              for the top classes
            items:
              $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorMultilabel'
            type: array
            x-versionadded: v2.24
        language:
          description: Detected language of the feature.
          type: string
          x-versionadded: v2.32
        lowInformation:
          description: Whether feature has too few values to be informative.
          type: boolean
        max:
          description: Maximum value of the EDA sample of the feature.
          nullable: true
          type: number
        mean:
          description: Arithmetic mean of the EDA sample of the feature.
          nullable: true
          type: number
        median:
          description: Median of the EDA sample of the feature.
          nullable: true
          type: number
        min:
          description: Minimum value of the EDA sample of the feature.
          nullable: true
          type: number
        naCount:
          description: Number of missing values.
          nullable: true
          type: integer
        name:
          description: Feature name
          type: string
        plot:
          description: Plot data based on feature values.
          items:
            $ref: '#/components/schemas/DatasetFeaturePlotDataResponse'
          nullable: true
          type: array
          x-versionadded: v2.30
        stdDev:
          description: Standard deviation of EDA sample of the feature.
          nullable: true
          type: number
        timeSeriesEligibilityReason:
          description: why the feature is ineligible for time series projects, or
            'suitable' if it is eligible.
          nullable: true
          type: string
        timeSeriesEligibilityReasonAggregation:
          description: why the feature is ineligible for aggregation, or 'suitable'
            if it is eligible.
          nullable: true
          type: string
          x-versionadded: v2.24
        timeSeriesEligible:
          description: whether this feature can be used as a datetime partitioning
            feature for time series projects.  Only sufficiently regular date features
            can be selected as the datetime feature for time series projects.  Always
            false for non-date features. Date features that cannot be used in datetime
            partitioning for a time series project may be eligible for an OTV project,
            which has less stringent requirements.
          type: boolean
        timeSeriesEligibleAggregation:
          description: whether this feature can be used as a datetime feature for
            aggregationfor time series data prep.  Always false for non-date features.
          type: boolean
          x-versionadded: v2.24
        timeStep:
          description: The minimum time step that can be used to specify time series
            windows.  The units for this value are the ``timeUnit``.  When specifying
            windows for time series projects, all windows must have durations that
            are integer multiples of this number. Only present for date features that
            are eligible for time series projects and null otherwise.
          nullable: true
          type: integer
        timeStepAggregation:
          description: The minimum time step that can be used to aggregate using this
            feature for time series data prep. The units for this value are the ``timeUnit``.  Only
            present for date features that are eligible for aggregation in time series
            data prep and null otherwise.
          nullable: true
          type: integer
          x-versionadded: v2.24
        timeUnit:
          description: The unit for the interval between values of this feature, e.g.
            DAY, MONTH, HOUR.  When specifying windows for time series projects, the
            windows are expressed in terms of this unit.  Only present for date features
            eligible for time series projects, and null otherwise.
          nullable: true
          type: string
        timeUnitAggregation:
          description: The unit for the interval between values of this feature, e.g.
            DAY, MONTH, HOUR.  Only present for date features eligible for aggregation,
            and null otherwise.
          nullable: true
          type: string
          x-versionadded: v2.24
        uniqueCount:
          description: Number of unique values.
          nullable: true
          type: integer
      required:
      - datasetId
      - datasetVersionId
      - dateFormat
      - featureType
      - id
      - name
      type: object
    DatasetFeaturelistListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of featurelists' details.
          items:
            $ref: '#/components/schemas/DatasetFeaturelistResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetFeaturelistResponse:
      properties:
        createdBy:
          description: '`username` of the user who created the dataset.'
          nullable: true
          type: string
        creationDate:
          description: the ISO 8601 formatted date and time when the dataset was created.
          format: date-time
          type: string
        datasetId:
          description: The ID of the dataset.
          type: string
        datasetVersionId:
          description: The ID of the dataset version if the featurelist is associated
            with a specific dataset version, for example Informative Features, or
            null otherwise.
          nullable: true
          type: string
        features:
          description: Features in the featurelist.
          items:
            type: string
          type: array
        id:
          description: The ID of the featurelist
          type: string
        name:
          description: The name of the featurelist
          type: string
        userCreated:
          description: True if the featurelist was created by a user vs the system.
          type: boolean
      required:
      - createdBy
      - creationDate
      - datasetId
      - datasetVersionId
      - features
      - id
      - name
      - userCreated
      type: object
    DatasetFeaturesListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: The list of features related to the requested dataset.
          items:
            $ref: '#/components/schemas/DatasetFeatureResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetFromFile:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        file:
          description: The data to be used for the creation.
          format: binary
          type: string
      required:
      - file
      type: object
    DatasetInputCreate:
      properties:
        sampling:
          $ref: '#/components/schemas/DatasetInputSampling'
          default: null
          description: Sampling data transformation.
          nullable: true
          x-versionadded: v2.33
      type: object
    DatasetInputSampling:
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/RandomSampleArgumentsCreate'
            default: {}
            description: The interactive sampling config.
          directive:
            description: The directive name.
            enum:
            - random-sample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/LimitDirectiveArguments'
            description: The interactive sampling config.
          directive:
            description: The directive name.
            enum:
            - limit
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/DatetimeSampleArgumentsCreate'
            default: {}
            description: The interactive sampling config.
          directive:
            description: The directive name.
            enum:
            - datetime-sample
            type: string
        required:
        - directive
        type: object
    DatasetListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of dataset details.
          items:
            $ref: '#/components/schemas/BasicDatasetWithSizeResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetProject:
      properties:
        id:
          description: The dataset's project ID.
          type: string
        url:
          description: The link to retrieve more information about the dataset version's
            project.
          type: string
      required:
      - id
      - url
      type: object
    DatasetProjectListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of information about dataset's projects
          items:
            $ref: '#/components/schemas/DatasetProjectResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetProjectResponse:
      properties:
        id:
          description: The dataset's project ID.
          type: string
        url:
          description: The link to retrieve more information about the dataset's project.
          type: string
      required:
      - id
      - url
      type: object
    DatasetRefresh:
      properties:
        dayOfMonth:
          default:
          - '*'
          description: The date(s) of the month that the job will run. Allowed values
            are either ``[1 ... 31]`` or ``["*"]`` for all days of the month. This
            field is additive with ``dayOfWeek``, meaning the job will run both on
            the date(s) defined in this field and the day specified by ``dayOfWeek``
            (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth``
            is set to ``["*"]`` and ``dayOfWeek`` is defined, the scheduler will trigger
            on every day of the month that matches ``dayOfWeek`` (for example, Tuesday
            the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are
            ignored.
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
            - 22
            - 23
            - 24
            - 25
            - 26
            - 27
            - 28
            - 29
            - 30
            - 31
          type: array
        dayOfWeek:
          default:
          - '*'
          description: The day(s) of the week that the job will run. Allowed values
            are ``[0 .. 6]``, where (Sunday=0), or ``["*"]``, for all days of the
            week. Strings, either 3-letter abbreviations or the full name of the day,
            can be used interchangeably (e.g., "sunday", "Sunday", "sun", or "Sun",
            all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning
            the job will run both on the date specified by ``dayOfMonth`` and the
            day defined in this field.
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - sunday
            - SUNDAY
            - Sunday
            - monday
            - MONDAY
            - Monday
            - tuesday
            - TUESDAY
            - Tuesday
            - wednesday
            - WEDNESDAY
            - Wednesday
            - thursday
            - THURSDAY
            - Thursday
            - friday
            - FRIDAY
            - Friday
            - saturday
            - SATURDAY
            - Saturday
            - sun
            - SUN
            - Sun
            - mon
            - MON
            - Mon
            - tue
            - TUE
            - Tue
            - wed
            - WED
            - Wed
            - thu
            - THU
            - Thu
            - fri
            - FRI
            - Fri
            - sat
            - SAT
            - Sat
          type: array
        hour:
          default:
          - '*'
          description: The hour(s) of the day that the job will run. Allowed values
            are ``[0 ... 23]``.
          oneOf:
          - enum:
            - '0'
            - '1'
            - '2'
            - '3'
            - '4'
            - '5'
            - '6'
            - '7'
            - '8'
            - '9'
            - '10'
            - '11'
            - '12'
            - '13'
            - '14'
            - '15'
            - '16'
            - '17'
            - '18'
            - '19'
            - '20'
            - '21'
            - '22'
            - '23'
            type: string
          - items:
              enum:
              - '0'
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              - '8'
              - '9'
              - '10'
              - '11'
              - '12'
              - '13'
              - '14'
              - '15'
              - '16'
              - '17'
              - '18'
              - '19'
              - '20'
              - '21'
              - '22'
              - '23'
              type: string
            type: array
        minute:
          default:
          - '*'
          description: The minute(s) of the day that the job will run. Allowed values
            are ``[0 ... 59]``.
          oneOf:
          - enum:
            - '0'
            - '1'
            - '2'
            - '3'
            - '4'
            - '5'
            - '6'
            - '7'
            - '8'
            - '9'
            - '10'
            - '11'
            - '12'
            - '13'
            - '14'
            - '15'
            - '16'
            - '17'
            - '18'
            - '19'
            - '20'
            - '21'
            - '22'
            - '23'
            - '24'
            - '25'
            - '26'
            - '27'
            - '28'
            - '29'
            - '30'
            - '31'
            - '32'
            - '33'
            - '34'
            - '35'
            - '36'
            - '37'
            - '38'
            - '39'
            - '40'
            - '41'
            - '42'
            - '43'
            - '44'
            - '45'
            - '46'
            - '47'
            - '48'
            - '49'
            - '50'
            - '51'
            - '52'
            - '53'
            - '54'
            - '55'
            - '56'
            - '57'
            - '58'
            - '59'
            type: string
          - items:
              enum:
              - '0'
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              - '8'
              - '9'
              - '10'
              - '11'
              - '12'
              - '13'
              - '14'
              - '15'
              - '16'
              - '17'
              - '18'
              - '19'
              - '20'
              - '21'
              - '22'
              - '23'
              - '24'
              - '25'
              - '26'
              - '27'
              - '28'
              - '29'
              - '30'
              - '31'
              - '32'
              - '33'
              - '34'
              - '35'
              - '36'
              - '37'
              - '38'
              - '39'
              - '40'
              - '41'
              - '42'
              - '43'
              - '44'
              - '45'
              - '46'
              - '47'
              - '48'
              - '49'
              - '50'
              - '51'
              - '52'
              - '53'
              - '54'
              - '55'
              - '56'
              - '57'
              - '58'
              - '59'
              type: string
            type: array
        month:
          default:
          - '*'
          description: 'The month(s) of the year that the job will run. Allowed values
            are either ``[1 ... 12]`` or ``["*"]`` for all months of the year. Strings,
            either 3-letter abbreviations or the full name of the month, can be used
            interchangeably (e.g., "jan" or "october"). Months that are not compatible
            with ``dayOfMonth`` are ignored, for example ``{"dayOfMonth": [31], "month":["feb"]}``.'
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - january
            - JANUARY
            - January
            - february
            - FEBRUARY
            - February
            - march
            - MARCH
            - March
            - april
            - APRIL
            - April
            - may
            - MAY
            - May
            - june
            - JUNE
            - June
            - july
            - JULY
            - July
            - august
            - AUGUST
            - August
            - september
            - SEPTEMBER
            - September
            - october
            - OCTOBER
            - October
            - november
            - NOVEMBER
            - November
            - december
            - DECEMBER
            - December
            - jan
            - JAN
            - Jan
            - feb
            - FEB
            - Feb
            - mar
            - MAR
            - Mar
            - apr
            - APR
            - Apr
            - jun
            - JUN
            - Jun
            - jul
            - JUL
            - Jul
            - aug
            - AUG
            - Aug
            - sep
            - SEP
            - Sep
            - oct
            - OCT
            - Oct
            - nov
            - NOV
            - Nov
            - dec
            - DEC
            - Dec
          type: array
      type: object
    DatasetRefreshExecutionResult:
      properties:
        completedAt:
          description: UTC completion date, in RFC-3339 format.
          format: date-time
          type: string
        datasetId:
          description: Dataset ID associated with this result.
          type: string
        datasetVersionId:
          description: Dataset version ID associated with this result
          type: string
        executionId:
          description: Result ID.
          type: string
        jobId:
          description: Job ID associated with this result.
          type: string
        message:
          description: Current status of execution.
          type: string
        startedAt:
          description: UTC start date, in RFC-3339 format.
          format: date-time
          type: string
        status:
          description: Status of this dataset refresh.
          enum:
          - INITIALIZING
          - REFRESHING
          - SUCCESS
          - ERROR
          type: string
      required:
      - completedAt
      - datasetId
      - datasetVersionId
      - executionId
      - jobId
      - message
      - startedAt
      - status
      type: object
    DatasetRefreshJobCreate:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
            The supported options are ``TRAINING``, and ``PREDICTION``.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        credentialId:
          default: null
          description: The ID of the set of credentials to use to run the scheduled
            job when the Kerberos authentication service is utilized. Required when
            useKerberos is true.
          nullable: true
          type: string
        credentials:
          description: A JSON string describing the data engine queries credentials
            to use when refreshing.
          type: string
        enabled:
          default: true
          description: Boolean for whether the scheduled job is active (true) or inactive
            (false).
          type: boolean
        name:
          description: Scheduled job name.
          maxLength: 256
          type: string
        schedule:
          $ref: '#/components/schemas/DatasetRefresh'
          description: Schedule describing when to refresh the dataset. The smallest
            schedule allowed is daily.
        scheduleReferenceDate:
          description: The UTC reference date in RFC-3339 format of when the schedule
            starts from. This value is returned in `/api/v2/datasets/(datasetId)/refreshJobs/(jobId)/`
            to help build a more intuitive schedule picker. The default is the current
            time.
          format: date-time
          type: string
        useKerberos:
          default: false
          description: If true, the Kerberos authentication system is used in conjunction
            with a credential ID.
          type: boolean
      required:
      - name
      - schedule
      type: object
    DatasetRefreshJobResponse:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        createdBy:
          description: The user who created this dataset refresh job.
          type: string
        credentialId:
          description: ID used to validate with Kerberos authentication service if
            Kerberos is enabled.
          nullable: true
          type: string
        credentials:
          description: A JSON string describing the data engine queries credentials
            to use when refreshing.
          type: string
        datasetId:
          description: ID of the dataset the user scheduled job applies to.
          type: string
        enabled:
          description: Indicates whether the scheduled job is active (true) or inactive(false).
          type: boolean
        jobId:
          description: The scheduled job ID.
          type: string
        name:
          description: The scheduled job's name.
          type: string
        schedule:
          $ref: '#/components/schemas/DatasetRefresh'
          description: Schedule describing when to refresh the dataset. The smallest
            schedule allowed is daily.
        scheduleReferenceDate:
          description: The UTC reference date in RFC-3339 format of when the schedule
            starts from. Can be used to help build a more intuitive schedule picker.
          format: date-time
          type: string
        updatedAt:
          description: The UTC date in RFC-3339 format of when the job was last updated.
          format: date-time
          type: string
        updatedBy:
          description: The user who last modified this dataset refresh job.
          type: string
        useKerberos:
          description: Boolean (true) if the Kerberos authentication service is needed
            when refreshing a job.
          type: boolean
      required:
      - categories
      - createdBy
      - credentialId
      - credentials
      - datasetId
      - enabled
      - jobId
      - name
      - schedule
      - scheduleReferenceDate
      - updatedAt
      - updatedBy
      - useKerberos
      type: object
    DatasetRefreshJobRetrieveExecutionResultsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: 'Array of dataset refresh results, returned latest first. '
          items:
            $ref: '#/components/schemas/DatasetRefreshExecutionResult'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetRefreshJobUpdate:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
            The supported options are ``TRAINING``, and ``PREDICTION``.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        credentialId:
          description: The ID of the set of credentials to use to run the scheduled
            job when the Kerberos authentication service is utilized. Required when
            useKerberos is true.
          nullable: true
          type: string
        credentials:
          description: A JSON string describing the data engine queries credentials
            to use when refreshing.
          type: string
        enabled:
          description: Boolean for whether the scheduled job is active (true) or inactive
            (false).
          type: boolean
        name:
          description: Scheduled job name.
          maxLength: 256
          type: string
        schedule:
          $ref: '#/components/schemas/DatasetRefresh'
          description: Schedule describing when to refresh the dataset. The smallest
            schedule allowed is daily.
        scheduleReferenceDate:
          description: The UTC reference date in RFC-3339 format of when the schedule
            starts from. This value is returned in `/api/v2/datasets/(datasetId)/refreshJobs/(jobId)/`
            to help build a more intuitive schedule picker. Required when ``schedule``
            is being updated. The default is the current time.
          format: date-time
          type: string
        useKerberos:
          description: If true, the Kerberos authentication system is used in conjunction
            with a credential ID.
          type: boolean
      type: object
    DatasetRefreshJobsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of information about scheduled dataset refresh jobs.
            Results are based on updatedAt value and returned in descending order
            (latest returned first).
          items:
            $ref: '#/components/schemas/DatasetRefreshJobResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetRelationshipCreate:
      properties:
        linkedDatasetId:
          description: The ID of another dataset with which to create relationships.
          type: string
        linkedFeatures:
          description: List of features belonging to the linked dataset.
          items:
            type: string
          minItems: 1
          type: array
        sourceFeatures:
          description: List of features belonging to the source dataset.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - linkedDatasetId
      - linkedFeatures
      - sourceFeatures
      type: object
    DatasetRelationshipListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of relationships' details.
          items:
            $ref: '#/components/schemas/DatasetRelationshipResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetRelationshipResponse:
      properties:
        createdBy:
          description: The username of the user that created this relationship.
          type: string
        creationDate:
          description: ISO-8601 formatted time/date that this record was created.
          format: date-time
          type: string
        id:
          description: ID of the dataset relationship
          type: string
        linkedDatasetId:
          description: ID of the linked dataset.
          type: string
        linkedFeatures:
          description: List of features belonging to the linked dataset.
          items:
            type: string
          type: array
        modificationDate:
          description: ISO-8601 formatted time/date that this record was last updated.
          format: date-time
          type: string
        modifiedBy:
          description: The username of the user that modified this relationship most
            recently.
          type: string
        sourceDatasetId:
          description: ID of the source dataset.
          type: string
        sourceFeatures:
          description: List of features belonging to the source dataset.
          items:
            type: string
          type: array
      required:
      - createdBy
      - creationDate
      - id
      - linkedDatasetId
      - linkedFeatures
      - modificationDate
      - modifiedBy
      - sourceDatasetId
      - sourceFeatures
      type: object
    DatasetRelationshipUpdate:
      properties:
        linkedDatasetId:
          description: id of another dataset with which to create relationships
          type: string
        linkedFeatures:
          description: list of features belonging to the linked dataset
          items:
            type: string
          minItems: 1
          type: array
        sourceFeatures:
          description: list of features belonging to the source dataset
          items:
            type: string
          minItems: 1
          type: array
      type: object
    DatasetRolesWithId:
      properties:
        canShare:
          default: false
          description: Whether the org/group/user should be able to share with others.
            If true, the org/group/user will be able to grant any role up to and including
            their own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare`
            is ignored.
          type: boolean
        canUseData:
          description: Whether the user/group/org should be able to view, download
            and process data (use to create projects, predictions, etc). For OWNER
            `canUseData` is always True. If `role` is empty `canUseData` is ignored.
          type: boolean
        id:
          description: The org/group/user ID.
          type: string
        role:
          description: The role of the org/group/user on this dataset or "NO_ROLE"
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: It describes the recipient type.
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    DatasetRolesWithNames:
      properties:
        canShare:
          default: false
          description: Whether the org/group/user should be able to share with others.
            If true, the org/group/user will be able to grant any role up to and including
            their own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare`
            is ignored.
          type: boolean
        canUseData:
          description: Whether the user/group/org should be able to view, download
            and process data (use to create projects, predictions, etc). For OWNER
            `canUseData` is always True. If `role` is empty `canUseData` is ignored.
          type: boolean
        name:
          description: Name of the user/group/org to update the access role for.
          type: string
        role:
          description: The role of the org/group/user on this dataset or "NO_ROLE"
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: It describes the recipient type.
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - name
      - role
      - shareRecipientType
      type: object
    DatasetSharedRoles:
      properties:
        applyGrantToLinkedObjects:
          default: false
          description: If true for any users being granted access to the dataset,
            grant the user read access to any linked objects such as DataSources and
            DataStores that may be used by this dataset. Ignored if no such objects
            are relevant for dataset. Will not result in access being lowered for
            a user if the user already has higher access to linked objects than read
            access. However, if the target user does not have sharing permissions
            to the linked object, they will be given sharing access without lowering
            existing permissions. May result in an error if user making call does
            not have sufficient permissions to complete grant. Default value is false.
          type: boolean
        operation:
          description: The name of the action being taken. The only operation is "updateRoles".
          enum:
          - updateRoles
          type: string
        roles:
          description: An array of RoleRequest objects. May contain at most 100 such
            objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/DatasetRolesWithNames'
            - $ref: '#/components/schemas/DatasetRolesWithId'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - operation
      - roles
      type: object
    DatasetTransformListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of transforms' details.
          items:
            $ref: '#/components/schemas/DatasetTransformResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DatasetTransformResponse:
      properties:
        dateExtraction:
          description: The value to extract from the date column.
          enum:
          - year
          - yearDay
          - month
          - monthDay
          - week
          - weekDay
          nullable: true
          type: string
        name:
          description: The feature name.
          type: string
        parentName:
          description: The name of the parent feature.
          type: string
        replacement:
          anyOf:
          - type: string
          - type: boolean
          - type: number
          - type: integer
          description: The replacement in case of a failed transformation.
          nullable: true
        variableType:
          description: The type of the transform.
          enum:
          - text
          - categorical
          - numeric
          - categoricalInt
          type: string
      required:
      - dateExtraction
      - name
      - parentName
      - replacement
      - variableType
      type: object
    DatasetsCredential:
      properties:
        catalogVersionId:
          description: ID of the catalog version
          type: string
        credentialId:
          description: ID of the credential store to be used for the given catalog
            version
          type: string
        url:
          description: The URL of the datasource
          nullable: true
          type: string
      required:
      - catalogVersionId
      - credentialId
      type: object
    Datasource:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentials'
          - $ref: '#/components/schemas/GoogleServiceAccountCredentials'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentials'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentials'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentials'
          x-versionadded: v2.23
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
          type: string
          x-versionadded: v2.19
        dataSourceId:
          description: The identifier for the DataSource to use as the source of data.
          type: string
        doSnapshot:
          default: true
          description: If true, create a snapshot dataset; if false, create a remote
            dataset. Creating snapshots from non-file sources requires an additional
            permission, `Enable Create Snapshot Data Source`.
          type: boolean
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server side in scope of HTTP request
            and never saved or stored. DEPRECATED: please use credentialId or credentialData
            instead.'
          type: string
          x-versiondeprecated: v2.23
        persistDataAfterIngestion:
          description: If true, will enforce saving all data (for download and sampling)
            and will allow a user to view extended data profile (which includes data
            statistics like min/max/median/mean, histogram, etc.). If false, will
            not enforce saving data. The data schema (feature names and types) still
            will be available. Specifying this parameter to false and `doSnapshot`
            to true will result in an error.
          type: boolean
        sampleSize:
          $ref: '#/components/schemas/SampleSize'
          description: Ingest size to use during dataset registration. Default behavior
            is to ingest full dataset.
          nullable: true
          x-versionadded: v2.27
        useKerberos:
          default: false
          description: If true, use kerberos authentication for database authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: 'The username for database authentication. DEPRECATED: please
            use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
      required:
      - dataSourceId
      type: object
    DatetimeModelDetailsResponse:
      properties:
        backtests:
          description: information on each backtesting fold of the model
          items:
            $ref: '#/components/schemas/BacktestStatusResponse'
          type: array
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
        dataSelectionMethod:
          description: Identifies which setting defines the training size of the model
            when making predictions and scoring. Only used by datetime models.
          enum:
          - duration
          - rowCount
          - selectedDateRange
          - useProjectSettings
          type: string
        effectiveFeatureDerivationWindowEnd:
          description: Only available for time series projects. How many timeUnits
            into the past relative to the forecast point the feature derivation window
            should end.
          maximum: 0
          type: integer
          x-versionadded: v2.16
        effectiveFeatureDerivationWindowStart:
          description: Only available for time series projects. How many timeUnits
            into the past relative to the forecast point the user needs to provide
            history for at prediction time. This can differ from the `featureDerivationWindowStart`
            set on the project due to the differencing method and period selected.
          exclusiveMaximum: true
          maximum: 0
          type: integer
          x-versionadded: v2.16
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
        forecastWindowEnd:
          description: Only available for time series projects. How many timeUnits
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          type: integer
          x-versionadded: v2.16
        forecastWindowStart:
          description: Only available for time series projects. How many timeUnits
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          type: integer
          x-versionadded: v2.16
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        holdoutScore:
          description: the holdout score of the model according to the project metric,
            if the score is available and the holdout is unlocked
          nullable: true
          type: number
        holdoutStatus:
          description: the status of the holdout fold
          enum:
          - COMPLETED
          - INSUFFICIENT_DATA
          - HOLDOUT_BOUNDARIES_EXCEEDED
          type: string
        id:
          description: the ID of the model
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
        isNClustersDynamicallyDetermined:
          description: Whether number of clusters is dynamically determined. Only
            valid in unsupervised clustering projects.
          type: boolean
        isStarred:
          description: whether the model has been starred
          type: boolean
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          description: Object returning model lifecycle.
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          nullable: true
          type: string
          x-versionadded: v2.21
        metrics:
          description: Object where each metric has validation, backtesting, backtestingScores
            and holdout scores reported, or null if they have not been computed. The
            `validation` score will be the score of the first backtest, which will
            be computed during initial model training.  The `backtesting` and  `backtestingScores`
            scores are computed when requested via :http:post:`/api/v2/projects/(projectId)/datetimeModels/(modelId)/backtests/`.
            The `backtesting` score is the average score across all backtests. The
            `backtestingScores` is an array of scores for each backtest, with the
            scores reported as null if the backtest score is unavailable. The `holdout`
            score is the score against the holdout data, using the training data defined
            in `trainingInfo`.
          example: "\n        {\n            \"metrics\": {\n                \"FVE\
            \ Poisson\": {\n                    \"holdout\": null,\n             \
            \       \"validation\": 0.56269,\n                    \"backtesting\"\
            : 0.50166,\n                    \"backtestingScores\": [0.51206, 0.49436,\
            \ null, 0.62516],\n                    \"crossValidation\": null\n   \
            \             },\n                \"RMSE\": {\n                    \"\
            holdout\": null,\n                    \"validation\": 21.0836,\n     \
            \               \"backtesting\": 23.361932,\n                    \"backtestingScores\"\
            : [0.4403, 0.4213, null, 0.5132],\n                    \"crossValidation\"\
            : null\n                }\n            }\n        }\n"
          type: object
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
        modelFamily:
          description: the family model belongs to, e.g. SVM, GBM, etc.
          type: string
          x-versionadded: v2.21
        modelFamilyFullName:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.31
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
        monotonicDecreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        monotonicIncreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          nullable: true
          type: integer
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
        predictionThreshold:
          description: threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.13
        predictionThresholdReadOnly:
          description: indicates whether modification of a predictions threshold is
            forbidden. Since v2.22 threshold modification is allowed.
          type: boolean
          x-versionadded: v2.13
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
        projectId:
          description: the ID of the project to which the model belongs
          type: string
        samplePct:
          description: always null for datetime models
          enum:
          - null
          type: string
        samplingMethod:
          description: indicates sampling method used to select training data in datetime
            models. For row-based project this is the way how requested number of
            rows are selected.For other projects (duration-based, start/end, project
            settings) - how specified percent of rows (timeWindowSamplePct) is selected
            from specified time window.
          enum:
          - random
          - latest
          type: string
        supportsComposableMl:
          description: indicates whether this model is supported in Composable ML.
          type: boolean
          x-versionadded: '2.26'
        supportsMonotonicConstraints:
          description: whether this model supports enforcing monotonic constraints
          type: boolean
          x-versionadded: v2.21
        timeWindowSamplePct:
          description: An integer between 1 and 99, indicating the percentage of sampling
            within the time window. The points kept are determined by samplingMethod
            option. Will be null if no sampling was specified. Only used by datetime
            models.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          nullable: true
          type: string
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          nullable: true
          type: string
        trainingInfo:
          $ref: '#/components/schemas/TrainingInfoResponse'
          description: holdout and prediction training data details
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          nullable: true
          type: string
        windowsBasisUnit:
          description: Only available for time series projects. Indicates which unit
            is the basis for the feature derivation window and the forecast window.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          type: string
          x-versionadded: v2.16
      required:
      - backtests
      - blueprintId
      - effectiveFeatureDerivationWindowEnd
      - effectiveFeatureDerivationWindowStart
      - featurelistId
      - featurelistName
      - forecastWindowEnd
      - forecastWindowStart
      - holdoutScore
      - holdoutStatus
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - lifecycle
      - linkFunction
      - metrics
      - modelCategory
      - modelFamily
      - modelFamilyFullName
      - modelNumber
      - modelType
      - monotonicDecreasingFeaturelistId
      - monotonicIncreasingFeaturelistId
      - parentModelId
      - predictionThreshold
      - predictionThresholdReadOnly
      - processes
      - projectId
      - samplePct
      - supportsComposableMl
      - supportsMonotonicConstraints
      - trainingDuration
      - trainingEndDate
      - trainingInfo
      - trainingRowCount
      - trainingStartDate
      - windowsBasisUnit
      type: object
    DatetimeModelRecordResponse:
      properties:
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
          x-versionadded: v2.33
        dataSelectionMethod:
          description: Identifies which setting defines the training size of the model
            when making predictions and scoring. Only used by datetime models.
          enum:
          - duration
          - rowCount
          - selectedDateRange
          - useProjectSettings
          type: string
          x-versionadded: v2.33
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
          x-versionadded: v2.33
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: the ID of the model
          type: string
          x-versionadded: v2.33
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
          x-versionadded: v2.33
        isStarred:
          description: whether the model has been starred
          type: boolean
          x-versionadded: v2.33
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
          x-versionadded: v2.33
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
          x-versionadded: v2.33
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        metrics:
          description: the performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or null if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
          x-versionadded: v2.33
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
          x-versionadded: v2.33
        modelFamily:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.33
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.33
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
          x-versionadded: v2.33
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
          x-versionadded: v2.33
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
          x-versionadded: v2.33
        projectId:
          description: the ID of the project to which the model belongs
          type: string
          x-versionadded: v2.33
        samplePct:
          description: the percentage of the dataset used in training the model
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: number
          x-versionadded: v2.33
        samplingMethod:
          description: indicates sampling method used to select training data in datetime
            models. For row-based project this is the way how requested number of
            rows are selected.For other projects (duration-based, start/end, project
            settings) - how specified percent of rows (timeWindowSamplePct) is selected
            from specified time window.
          enum:
          - random
          - latest
          type: string
          x-versionadded: v2.33
        timeWindowSamplePct:
          description: An integer between 1 and 99, indicating the percentage of sampling
            within the time window. The points kept are determined by samplingMethod
            option. Will be null if no sampling was specified. Only used by datetime
            models.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.33
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          nullable: true
          type: string
          x-versionadded: v2.33
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.33
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
      required:
      - blueprintId
      - featurelistId
      - featurelistName
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - metrics
      - modelCategory
      - modelFamily
      - modelNumber
      - modelType
      - parentModelId
      - processes
      - projectId
      - samplePct
      - trainingDuration
      - trainingEndDate
      - trainingRowCount
      - trainingStartDate
      type: object
    DatetimeModelSubmissionResponse:
      properties:
        message:
          description: Any extended message to include about the result. For example,
            if a job is submitted that is a duplicate of a job that has already been
            added to the queue, the message will mention that no new job was created.
          type: string
      required:
      - message
      type: object
    DatetimeModelsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: each has the same schema as if retrieving the model individually
            from :http:get:`/api/v2/projects/(projectId)/datetimeModels/(modelId)/`.
          items:
            $ref: '#/components/schemas/DatetimeModelDetailsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    DatetimePartitioningDataForOpenApi:
      properties:
        aggregationType:
          description: For multiseries projects only. The aggregation type to apply
            when creating cross-series features.
          enum:
          - total
          - average
          type: string
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          default: false
          description: Specifies whether the time series predictions can use partial
            historical data.
          type: boolean
          x-versionadded: v2.24
        autopilotClusterList:
          description: A list of integers where each value will be used as the number
            of clusters in Autopilot model(s) for unsupervised clustering projects.
            Cannot be specified unless `unsupervisedMode` is true and `unsupervisedType`
            is set to `clustering`.
          items:
            maximum: 100
            minimum: 2
            type: integer
          maxItems: 10
          nullable: true
          type: array
          x-versionadded: v2.25
        autopilotDataSamplingMethod:
          description: Defines how autopilot will select subsample from training dataset
            in OTV/TS projects. Defaults to 'latest' for 'rowCount' dataSelectionMethod
            and to 'random' for 'duration'.
          enum:
          - random
          - latest
          type: string
        autopilotDataSelectionMethod:
          description: The Data Selection method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - duration
          - rowCount
          type: string
        backtests:
          description: An array specifying individual backtests.
          items:
            oneOf:
            - $ref: '#/components/schemas/BacktestOldMethodForOpenApi'
              description: Method 1 - pass validation and gap durations
            - $ref: '#/components/schemas/BacktestNewMethodForOpenApi'
              description: Method 2 - directly configure the start and end dates of
                each partition, including the training partition.
          maxItems: 20
          minItems: 1
          type: array
        calendarId:
          description: The ID of the calendar to be used in this project.
          type: string
          x-versionadded: v2.15
        clusteringBufferDisabled:
          default: false
          description: A boolean value indicating whether an clustering buffer creation
            should be disabled for unsupervised time series clustering project.
          type: boolean
          x-versionadded: v2.30
        crossSeriesGroupByColumns:
          description: For multiseries projects with cross-series features enabled
            only. List of columns (currently of length 1). Setting that indicates
            how to further split series into related groups. For example, if every
            series is sales of an individual product, the series group-by could be
            the product category with values like "men's clothing", "sports equipment",
            etc.
          items:
            type: string
          maxItems: 1
          type: array
          x-versionadded: v2.15
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column.
          type: string
        defaultToAPriori:
          description: Renamed to `defaultToKnownInAdvance`.
          type: boolean
          x-versiondeprecated: v2.11
        defaultToDoNotDerive:
          description: For time series projects only. Sets whether all features default
            to being treated as do-not-derive features, excluding them from feature
            derivation. Individual features can be set to a value different than the
            default by using the `featureSettings` parameter.
          type: boolean
          x-versionadded: v2.17
        defaultToKnownInAdvance:
          description: For time series projects only. Sets whether all features default
            to being treated as known in advance features, which are features that
            are known into the future. Features marked as known in advance must be
            specified into the future when making predictions. The default is false,
            all features are not known in advance. Individual features can be set
            to a value different than the default using the `featureSettings` parameter.
            See the :ref:`Time Series Overview <time_series_overview>` for more context.
          type: boolean
          x-versionadded: v2.11
        differencingMethod:
          description: For time series projects only. Used to specify which differencing
            method to apply if the data is stationary. For classification problems
            `simple` and `seasonal` are not allowed. Parameter `periodicities` must
            be specified if `seasonal` is chosen. Defaults to `auto`.
          enum:
          - auto
          - none
          - simple
          - seasonal
          type: string
          x-versionadded: v2.9
        disableHoldout:
          default: false
          description: Whether to suppress allocating a holdout fold. If `disableHoldout`
            is set to true, `holdoutStartDate` and `holdoutDuration` must not be set.
          type: boolean
          x-versionadded: v2.8
        featureDerivationWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should end.
          maximum: 0
          type: integer
          x-versionadded: v2.8
        featureDerivationWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should begin.
          maximum: 0
          type: integer
          x-versionadded: v2.8
        featureSettings:
          description: An array specifying per feature settings. Features can be left
            unspecified.
          items:
            $ref: '#/components/schemas/FeatureSetting'
          type: array
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          type: integer
          x-versionadded: v2.8
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          type: integer
          x-versionadded: v2.8
        gapDuration:
          description: The duration of the gap between holdout training and holdout
            scoring data. For time series projects, defaults to the duration of the
            gap between the end of the feature derivation window and the beginning
            of the forecast window. For OTV projects, defaults to a zero duration
            (P0Y0M0D).
          format: duration
          type: string
        holdoutDuration:
          description: The duration of holdout scoring data. When specifying `holdoutDuration`,
            `holdoutStartDate` must also be specified. This attribute cannot be specified
            when `disableHoldout` is true.
          format: duration
          type: string
        holdoutEndDate:
          description: The end date of holdout scoring data. When specifying `holdoutEndDate`,
            `holdoutStartDate` must also be specified. This attribute cannot be specified
            when `disableHoldout` is true.
          format: date-time
          type: string
        holdoutStartDate:
          description: The start date of holdout scoring data. When specifying `holdoutStartDate`,
            one of `holdoutEndDate` or `holdoutDuration` must also be specified. This
            attribute cannot be specified when `disableHoldout` is true.
          format: date-time
          type: string
        isHoldoutModified:
          description: A boolean value indicating whether holdout settings (start/end
            dates) have been modified by user.
          type: boolean
        modelSplits:
          default: 5
          description: 'Sets the cap on the number of jobs per model used when building
            models to control number of jobs in the queue. Higher number of modelSplits
            will allow for less downsampling leading to the use of more post-processed
            data. '
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.21
        multiseriesIdColumns:
          description: May be used only with time series projects. An array of the
            column names identifying  the series to which each row of the dataset
            belongs. Currently only one multiseries ID column is supported. See the
            :ref:`multiseries <multiseries>` section of the time series documentation
            for more context.
          items:
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.11
        numberOfBacktests:
          description: The number of backtests to use. If omitted, defaults to a positive
            value selected by the server based on the validation and gap durations.
          maximum: 20
          minimum: 1
          type: integer
        periodicities:
          description: A list of periodicities for time series projects only. For
            classification problems periodicities are not allowed. If this is provided,
            parameter 'differencing_method' will default to 'seasonal' if not provided
            or 'auto'.
          items:
            $ref: '#/components/schemas/Periodicity'
          type: array
        treatAsExponential:
          description: For time series projects only. Used to specify whether to treat
            data as exponential trend and apply transformations like log-transform.
            For classification problems `always` is not allowed. Defaults to `auto`.
          enum:
          - auto
          - never
          - always
          type: string
          x-versionadded: v2.9
        unsupervisedMode:
          default: false
          description: A boolean value indicating whether an unsupervised project
            should be created.
          type: boolean
          x-versionadded: v2.20
        unsupervisedType:
          description: The type of unsupervised project. Only valid when `unsupervisedMode`
            is true. If `unsupervisedMode`, defaults to `anomaly`.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.23
        useCrossSeriesFeatures:
          default: false
          description: For multiseries projects only. Indicating whether to use cross-series
            features.
          type: boolean
          x-versionadded: v2.14
        useSupervisedFeatureReduction:
          default: true
          description: When true, during feature generation DataRobot runs a supervised
            algorithm that identifies those features with predictive impact on the
            target and builds feature lists using only qualifying features. Setting
            false can severely impact autopilot duration, especially for datasets
            with many features.
          type: boolean
        useTimeSeries:
          default: false
          description: A boolean value indicating whether a time series project should
            be created instead of a regular project which uses datetime partitioning.
          type: boolean
          x-versionadded: v2.8
        validationDuration:
          description: The default validation duration for all backtests. If the primary
            date/time feature in a time series project is irregular, you cannot set
            a default validation length. Instead, set each duration individually.
            For an OTV project setting the validation duration will always use regular
            partitioning. Omitting it will use irregular partitioning if the date/time
            feature is irregular.
          format: duration
          type: string
        windowsBasisUnit:
          description: For time series projects only. Indicates which unit is basis
            for feature derivation window and forecast window. Valid options are detected
            time unit or `ROW`. If omitted, the default value is detected time unit.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          type: string
          x-versionadded: v2.14
      required:
      - datetimePartitionColumn
      type: object
    DatetimePartitioningLogListControllerResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        datetimePartitioningLog:
          description: The content of the date/time partitioning log.
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalLogLines:
          description: The total number of lines in feature derivation log.
          type: integer
      required:
      - count
      - datetimePartitioningLog
      - next
      - previous
      - totalLogLines
      type: object
    DatetimePartitioningResponse:
      properties:
        aggregationType:
          description: For multiseries projects only. The aggregation type to apply
            when creating cross-series features.
          enum:
          - total
          - average
          nullable: true
          type: string
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          description: Specifies whether the time series predictions can use partial
            historical data.
          nullable: true
          type: boolean
          x-versionadded: v2.31
        autopilotDataSamplingMethod:
          description: The Data Sampling method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - random
          - latest
          type: string
        autopilotDataSelectionMethod:
          description: The Data Selection method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - duration
          - rowCount
          type: string
        availableHoldoutEndDate:
          description: The maximum valid date of holdout scoring data.
          format: date-time
          nullable: true
          type: string
        availableTrainingDuration:
          description: The duration of available training duration for scoring the
            holdout.
          format: duration
          type: string
        availableTrainingEndDate:
          description: The end date of available training data for scoring the holdout.
          format: date-time
          type: string
        availableTrainingStartDate:
          description: The start date of available training data for scoring the holdout.
          format: date-time
          type: string
        backtests:
          description: An array of the configured backtests.
          items:
            $ref: '#/components/schemas/BacktestResponse'
          maxItems: 20
          minItems: 1
          type: array
        calendarId:
          description: The ID of the calendar to be used in this project.
          nullable: true
          type: string
          x-versionadded: v2.15
        calendarName:
          description: The name of the calendar used in this project.
          nullable: true
          type: string
          x-versionadded: v2.17
        clusteringBufferDisabled:
          default: false
          description: A boolean value indicating whether an clustering buffer creation
            should be disabled for unsupervised time series clustering project.
          type: boolean
          x-versionadded: v2.30
        crossSeriesGroupByColumns:
          description: For multiseries projects with cross-series features enabled
            only. List of columns (currently of length 1). Setting that indicates
            how to further split series into related groups. For example, if every
            series is sales of an individual product, the series group-by could be
            the product category with values like "men's clothing", "sports equipment",
            etc.
          items:
            type: string
          maxItems: 1
          nullable: true
          type: array
          x-versionadded: v2.15
        dateFormat:
          description: The date format of the partition column.
          type: string
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column.
          type: string
        datetimePartitioningId:
          description: The ID of the current optimized datetime partitioning
          type: string
          x-versionadded: v2.30
        defaultToAPriori:
          description: Renamed to `defaultToKnownInAdvance`.
          type: boolean
          x-versiondeprecated: v2.11
        defaultToDoNotDerive:
          description: For time series projects only. Sets whether all features default
            to being treated as do-not-derive features, excluding them from feature
            derivation. Individual features can be set to a value different than the
            default by using the `featureSettings` parameter.
          type: boolean
          x-versionadded: v2.17
        defaultToKnownInAdvance:
          description: For time series projects only. Sets whether all features default
            to being treated as known in advance features, which are features that
            are known into the future. Features marked as known in advance must be
            specified into the future when making predictions. The default is false,
            all features are not known in advance. Individual features can be set
            to a value different than the default using the `featureSettings` parameter.
            See the :ref:`Time Series Overview <time_series_overview>` for more context.
          type: boolean
          x-versionadded: v2.11
        differencingMethod:
          description: For time series projects only. Used to specify which differencing
            method to apply if the data is stationary. For classification problems
            `simple` and `seasonal` are not allowed. Parameter `periodicities` must
            be specified if `seasonal` is chosen. Defaults to `auto`.
          enum:
          - auto
          - none
          - simple
          - seasonal
          nullable: true
          type: string
          x-versionadded: v2.9
        disableHoldout:
          description: A boolean value indicating whether date partitioning skipped
            allocating a holdout fold.
          type: boolean
          x-versionadded: v2.8
        featureDerivationWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should end.
          maximum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        featureDerivationWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should begin.
          maximum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        featureSettings:
          description: An array specifying per feature settings. Features can be left
            unspecified.
          items:
            $ref: '#/components/schemas/FeatureSetting'
          type: array
          x-versionadded: v2.9
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        gapDuration:
          description: The duration of the gap between the training and holdout scoring
            data.
          format: duration
          type: string
        gapEndDate:
          description: The end date of the gap between the training and holdout scoring
            data.
          format: date-time
          type: string
        gapStartDate:
          description: The start date of the gap between the training and holdout
            scoring data.
          format: date-time
          type: string
        holdoutDuration:
          description: The duration of the holdout scoring data.
          format: duration
          type: string
        holdoutEndDate:
          description: The end date of holdout scoring data.
          format: date-time
          type: string
        holdoutStartDate:
          description: The start date of holdout scoring data.
          format: date-time
          type: string
        isHoldoutModified:
          description: A boolean value indicating whether holdout settings (start/end
            dates) have been modified by user.
          type: boolean
        modelSplits:
          description: 'Sets the cap on the number of jobs per model used when building
            models to control number of jobs in the queue. Higher number of modelSplits
            will allow for less downsampling leading to the use of more post-processed
            data. '
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.21
        multiseriesIdColumns:
          description: May be used only with time series projects. An array of the
            column names identifying  the series to which each row of the dataset
            belongs. Currently only one multiseries ID column is supported. See the
            :ref:`multiseries <multiseries>` section of the time series documentation
            for more context.
          items:
            type: string
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.11
        numberOfBacktests:
          description: The number of backtests to use. If omitted, defaults to a positive
            value selected by the server based on the validation and gap durations.
          maximum: 20
          minimum: 1
          type: integer
        numberOfDoNotDeriveFeatures:
          description: Number of features that are marked as "do not derive".
          type: integer
          x-versionadded: v2.17
        numberOfKnownInAdvanceFeatures:
          description: Number of features that are marked as "known in advance".
          type: integer
          x-versionadded: v2.14
        partitioningExtendedWarnings:
          description: An array of available warnings about potential problems with
            the chosen partitioning that could cause issues during modeling, although
            the partitioning may be successfully submitted.
          items:
            $ref: '#/components/schemas/PartitioningExtendedWarning'
          type: array
        partitioningWarnings:
          description: An array of available warnings about potential problems with
            the chosen partitioning that could cause issues during modeling, although
            the partitioning may be successfully submitted.
          items:
            $ref: '#/components/schemas/PartitioningWarning'
          type: array
        periodicities:
          description: A list of periodicities for time series projects only. For
            classification problems periodicities are not allowed. If this is provided,
            parameter 'differencing_method' will default to 'seasonal' if not provided
            or 'auto'.
          items:
            $ref: '#/components/schemas/Periodicity'
          nullable: true
          type: array
        primaryTrainingDuration:
          description: The duration of primary training duration for scoring the holdout.
          format: duration
          type: string
        primaryTrainingEndDate:
          description: The end date of primary training data for scoring the holdout.
          format: date-time
          type: string
        primaryTrainingStartDate:
          description: The start date of primary training data for scoring the holdout.
          format: date-time
          type: string
        projectId:
          description: The ID of the project.
          type: string
        treatAsExponential:
          description: For time series projects only. Used to specify whether to treat
            data as exponential trend and apply transformations like log-transform.
            For classification problems `always` is not allowed. Defaults to `auto`.
          enum:
          - auto
          - never
          - always
          nullable: true
          type: string
          x-versionadded: v2.9
        unsupervisedMode:
          description: A boolean value indicating whether an unsupervised project
            should be created.
          nullable: true
          type: boolean
          x-versionadded: v2.31
        unsupervisedType:
          description: The type of unsupervised project.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.31
        useCrossSeriesFeatures:
          description: For multiseries projects only. Indicating whether to use cross-series
            features.
          nullable: true
          type: boolean
          x-versionadded: v2.14
        useTimeSeries:
          description: A boolean value indicating whether a time series project should
            be created instead of a regular project which uses datetime partitioning.
          type: boolean
          x-versionadded: v2.8
        validationDuration:
          description: The default validation duration for all backtests. If the primary
            date/time feature in a time series project is irregular, you cannot set
            a default validation length. Instead, set each duration individually.
          format: duration
          nullable: true
          type: string
        windowsBasisUnit:
          description: For time series projects only. Indicates which unit is basis
            for feature derivation window and forecast window. Valid options are detected
            time unit or `ROW`. If omitted, the default value is detected time unit.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          nullable: true
          type: string
          x-versionadded: v2.14
      required:
      - autopilotDataSamplingMethod
      - autopilotDataSelectionMethod
      - availableHoldoutEndDate
      - availableTrainingDuration
      - availableTrainingEndDate
      - availableTrainingStartDate
      - backtests
      - dateFormat
      - datetimePartitionColumn
      - defaultToAPriori
      - defaultToDoNotDerive
      - defaultToKnownInAdvance
      - differencingMethod
      - disableHoldout
      - featureDerivationWindowEnd
      - featureDerivationWindowStart
      - featureSettings
      - forecastWindowEnd
      - forecastWindowStart
      - gapDuration
      - gapEndDate
      - gapStartDate
      - holdoutDuration
      - holdoutEndDate
      - holdoutStartDate
      - multiseriesIdColumns
      - numberOfBacktests
      - numberOfDoNotDeriveFeatures
      - numberOfKnownInAdvanceFeatures
      - partitioningWarnings
      - periodicities
      - primaryTrainingDuration
      - primaryTrainingEndDate
      - primaryTrainingStartDate
      - projectId
      - treatAsExponential
      - useTimeSeries
      - validationDuration
      - windowsBasisUnit
      type: object
    DatetimeSampleArgumentsCreate:
      properties:
        datetimePartitionColumn:
          description: The datetime partition column to order by.
          type: string
          x-versionadded: v2.33
        multiseriesIdColumn:
          default: null
          description: The series ID column, if present.
          nullable: true
          type: string
          x-versionadded: v2.33
        rows:
          default: 10000
          description: The number of rows to be sampled.
          maximum: 10000
          minimum: 1
          type: integer
          x-versionadded: v2.33
        selectedSeries:
          description: The selected series to be sampled. Requires "multiseriesIdColumn".
          items:
            type: string
          maxItems: 1000
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        strategy:
          default: earliest
          description: Sets whether to take the latest or earliest rows relative to
            the datetime partition column.
          enum:
          - earliest
          - latest
          type: string
          x-versionadded: v2.33
      required:
      - datetimePartitionColumn
      - strategy
      type: object
    DatetimeTrendPlotsBacktestMetadata:
      properties:
        training:
          $ref: '#/components/schemas/DatetimeTrendPlotsMetadataStartEndDates'
          description: Start and end dates for the backtest/holdout training.
        validation:
          $ref: '#/components/schemas/DatetimeTrendPlotsMetadataStartEndDates'
          description: Start and end dates for the backtest/holdout validation.
      required:
      - training
      - validation
      type: object
    DatetimeTrendPlotsCreate:
      properties:
        backtest:
          default: 0
          description: Compute plots for a specific backtest (use the backtest index
            starting from zero) or `holdout`. If not specified the first backtest
            (backtest index 0) will be used.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
        forecastDistanceEnd:
          description: The end of forecast distance range (forecast window) to compute.
            If not specified, the last forecast distance for this project will be
            used. Forecast distance specifies the number of time steps between the
            predicted point and the origin point. Only available for time series supervised
            projects.
          minimum: 0
          type: integer
        forecastDistanceStart:
          description: The start of forecast distance range (forecast window) to compute.
            If not specified, the first forecast distance for this project will be
            used. Forecast distance specifies the number of time steps between the
            predicted point and the origin point. Only available for time series supervised
            projects.
          minimum: 0
          type: integer
        fullAverage:
          default: false
          description: Whether to compute an average plot for all series. Only available
            for time series multiseries projects.
          type: boolean
          x-versionadded: '2.28'
        seriesIds:
          description: 'Only available for time series multiseries projects. Each
            element should be a name of a single series in a multiseries project.
            It is possible to compute a maximum of 1000 series per one request. If
            not specified the first 1000 series in alphabetical order will be computed.
            It is not possible to specify `fullAverage: true` while also setting `seriesIds`.
            This parameter can only be specified after first 1000 series in alphabetical
            order are computed.'
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: '2.28'
        source:
          default: validation
          description: The source of the data for the backtest/holdout.
          enum:
          - training
          - validation
          type: string
      type: object
    DatetimeTrendPlotsMetadataStartEndDates:
      properties:
        endDate:
          description: The datetime of the end of the chart data (exclusive). Null
            if chart data is not computed.
          format: date-time
          nullable: true
          type: string
        startDate:
          description: The datetime of the start of the chart data (inclusive). Null
            if chart data is not computed.
          format: date-time
          nullable: true
          type: string
      required:
      - endDate
      - startDate
      type: object
    DatetimeTrendPlotsPreviewBins:
      properties:
        actual:
          description: Average actual value of the target in the bin. `null` if there
            are no entries in the bin.
          nullable: true
          type: number
        endDate:
          description: 'The datetime of the end of the bin (exclusive). '
          format: date-time
          type: string
        predicted:
          description: Average prediction of the model in the bin. `null` if there
            are no entries in the bin.
          nullable: true
          type: number
        startDate:
          description: 'The datetime of the start of the bin (inclusive). '
          format: date-time
          type: string
      required:
      - actual
      - endDate
      - predicted
      - startDate
      type: object
    DatetimeTrendPlotsPreviewResponse:
      properties:
        bins:
          description: An array of bins for the retrieved plots.
          items:
            $ref: '#/components/schemas/DatetimeTrendPlotsPreviewBins'
          maxItems: 1000
          minItems: 1
          type: array
        endDate:
          description: 'The datetime of the end of the chart data (exclusive). '
          format: date-time
          type: string
        startDate:
          description: 'The datetime of the start of the chart data (inclusive). '
          format: date-time
          type: string
      required:
      - bins
      - endDate
      - startDate
      type: object
    DatetimeTrendPlotsResponse:
      properties:
        message:
          description: Any extended message to include about the result. For example,
            if a job is submitted that is a duplicate of a job that has already been
            added to the queue, the message will mention that no new job can be created.
          type: string
      type: object
    DeletedDeploymentListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of deleted deployments.
          items:
            $ref: '#/components/schemas/DeletedDeploymentResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    DeletedDeploymentResponse:
      properties:
        deletedAt:
          description: The date and time of when the deployment was deleted, in ISO
            8601 format.
          format: date-time
          type: string
        id:
          description: ID of the deployment.
          type: string
        label:
          description: Label of the deployment.
          maxLength: 512
          type: string
      required:
      - deletedAt
      - id
      - label
      type: object
    DeletedProjectCountResponse:
      properties:
        deletedProjectsCount:
          description: Amount of soft-deleted projects. The value is limited by projectCountLimit
          minimum: 0
          type: integer
        projectCountLimit:
          description: Deleted projects counting limit value. Stop counting above
            this limit
          minimum: 0
          type: integer
        valueExceedsLimit:
          description: If an actual number of soft-deleted projects exceeds counting
            limit
          type: boolean
      required:
      - deletedProjectsCount
      - projectCountLimit
      - valueExceedsLimit
      type: object
    DeletedProjectListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of deleted projects
          items:
            $ref: '#/components/schemas/DeletedProjectResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    DeletedProjectOrganization:
      properties:
        id:
          description: ID of the organization the project belongs to
          type: string
        name:
          description: Name of the organization the project belongs to
          type: string
      required:
      - id
      - name
      type: object
    DeletedProjectResponse:
      properties:
        createdBy:
          $ref: '#/components/schemas/DeletedProjectUser'
          description: The user who created the project
          nullable: true
        deletedBy:
          $ref: '#/components/schemas/DeletedProjectUser'
          description: The user who deleted the project
          nullable: true
        deletionTime:
          description: ISO-8601 formatted date when project was deleted
          format: date-time
          nullable: true
          type: string
        fileName:
          description: The name of the file uploaded for the project dataset
          nullable: true
          type: string
        id:
          description: The ID of the project
          type: string
        organization:
          $ref: '#/components/schemas/DeletedProjectOrganization'
          description: The organization the project belongs to
          nullable: true
        projectName:
          default: Untitled Project
          description: The name of the project
          type: string
        scheduledForDeletion:
          description: Whether project permanent deletion has already been scheduled
          type: boolean
      required:
      - createdBy
      - deletedBy
      - deletionTime
      - fileName
      - id
      - organization
      - projectName
      - scheduledForDeletion
      type: object
    DeletedProjectUser:
      properties:
        email:
          description: Email of the user
          type: string
        id:
          description: ID of the user
          type: string
      required:
      - email
      - id
      type: object
    DependencyBuildLogResponse:
      properties:
        data:
          description: The custom model version's dependency build log in tar.gz format.
          format: binary
          type: string
      required:
      - data
      type: object
    DependencyConstraint:
      properties:
        constraintType:
          description: The constraint type to apply to the version.
          enum:
          - <
          - <=
          - ==
          - '>='
          - '>'
          type: string
        version:
          description: The version label to use in the constraint.
          type: string
      required:
      - constraintType
      - version
      type: object
    DependencyResponse:
      properties:
        constraints:
          description: Constraints that should be applied to the dependency when installed.
          items:
            $ref: '#/components/schemas/DependencyConstraint'
          type: array
        extras:
          description: The dependency's package extras.
          type: string
        line:
          description: The original line from the requirements.txt file.
          type: string
        lineNumber:
          description: The line number the requirement was on in requirements.txt.
          type: integer
        packageName:
          description: The dependency's package name.
          type: string
      required:
      - constraints
      - line
      - lineNumber
      - packageName
      type: object
    DeploymentAccuracyHealthResponse:
      properties:
        endDate:
          description: End date of accuracy health period.
          format: date-time
          nullable: true
          type: string
        message:
          description: A message providing more detail on the status.
          type: string
        startDate:
          description: Start date of accuracy health period.
          format: date-time
          nullable: true
          type: string
        status:
          description: Accuracy health status.
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    DeploymentActuals:
      properties:
        data:
          description: A list of `actual` objects that describes actual values. Minimum
            size of the list is 1 and maximum size is 10000 items. An `actual` object
            has the following schema.
          items:
            $ref: '#/components/schemas/Actual'
          minItems: 1
          type: array
        keepActualsWithoutPredictions:
          default: true
          description: Indicates if actual without predictions are kept.
          type: boolean
      required:
      - data
      type: object
    DeploymentApproveChange:
      properties:
        approvalStatus:
          description: Deployment approval status to set.
          enum:
          - APPROVED
          type: string
      required:
      - approvalStatus
      type: object
    DeploymentCapabilitiesResponse:
      properties:
        supportsAutomaticActuals:
          description: With this feature enabled, DataRobot infers actual values from
            time series history data and automatically feeds them back for accuracy
            estimation.
          type: boolean
          x-versionadded: v2.25
          x-versiondeprecated: v2.29
        supportsChallengerModels:
          description: If the deployment supports challenger models.
          type: boolean
          x-versionadded: v2.23
          x-versiondeprecated: v2.29
        supportsFeatureDriftTracking:
          description: If the deployment supports feature drift tracking.
          type: boolean
          x-versiondeprecated: v2.29
        supportsFeatureTypeInfoValidation:
          description: If the deployment supports feature type information validation.
            This will be True for deployments created from imported model packages
            whose feature data contains feature type information.
          type: boolean
          x-versionadded: v2.27
          x-versiondeprecated: v2.29
        supportsHumilityRecommendedRules:
          description: If the deployment supports calculating values for humility
            recommended rules.
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: v2.29
        supportsHumilityRules:
          description: If the deployment supports humble ai.
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: v2.29
        supportsHumilityRulesDefaultCalculations:
          description: If the deployment supports calculating default values for humility
            rules.
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: v2.29
        supportsModelReplacement:
          description: If the deployment supports model replacement.
          type: boolean
          x-versiondeprecated: v2.29
        supportsPortablePredictionServer:
          description: If the deployment supports portable prediction servers. this
            enables to downloada dedicated model package to be deployed on external
            prediction environments
          type: boolean
          x-versionadded: v2.23
          x-versiondeprecated: v2.29
        supportsPredictionIntervals:
          description: if the deployment supports prediction intervals.
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: v2.29
        supportsPredictionWarning:
          description: If the deployment supports prediction warnings.
          type: boolean
          x-versionadded: v2.20
          x-versiondeprecated: v2.29
        supportsRetraining:
          description: Whether deployment supports retraining.
          type: boolean
          x-versionadded: v2.28
          x-versiondeprecated: v2.29
        supportsScoringCodeDownload:
          description: If the currently deployed model supports scoring code download.
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: v2.29
        supportsSecondaryDatasets:
          description: If the deployments supports secondary datasets.
          type: boolean
          x-versionadded: v2.28
          x-versiondeprecated: v2.29
        supportsSegmentedAnalysisDriftAndAccuracy:
          description: If the deployment supports tracking features in training and
            predictions data for segmented analysis of drift and accuracy.
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: v2.29
        supportsShapBasedPredictionExplanations:
          description: If the currently deployed model supports shap based prediction
            explanations.
          type: boolean
          x-versionadded: v2.22
          x-versiondeprecated: v2.29
        supportsTargetDriftTracking:
          description: If the deployment supports target drift tracking.
          type: boolean
          x-versiondeprecated: v2.29
      required:
      - supportsChallengerModels
      - supportsFeatureDriftTracking
      - supportsHumilityRecommendedRules
      - supportsHumilityRules
      - supportsHumilityRulesDefaultCalculations
      - supportsModelReplacement
      - supportsPredictionIntervals
      - supportsPredictionWarning
      - supportsSecondaryDatasets
      - supportsTargetDriftTracking
      type: object
    DeploymentCapabilitiesRetrieveResponse:
      properties:
        data:
          description: List of all capabilities.
          items:
            $ref: '#/components/schemas/DeploymentCapability'
          type: array
      required:
      - data
      type: object
    DeploymentCapability:
      properties:
        messages:
          description: Messages explaining why the capability is supported or not
            supported.
          items:
            type: string
          type: array
        name:
          description: The name of the capability.
          type: string
        supported:
          description: If the capability is supported.
          type: boolean
      required:
      - messages
      - name
      - supported
      type: object
    DeploymentChangeImportanceChange:
      properties:
        importance:
          description: Deployment Importance to set.
          enum:
          - CRITICAL
          - HIGH
          - MODERATE
          - LOW
          type: string
      required:
      - importance
      type: object
    DeploymentChangeStatusChange:
      properties:
        status:
          description: Deployment status to set.
          enum:
          - active
          - inactive
          type: string
      required:
      - status
      type: object
    DeploymentCleanupStatsChange:
      properties:
        dataType:
          description: Type of stats to cleanup.
          enum:
          - monitoring
          type: string
        end:
          description: If specified, the stats will be cleaned up to this timestamp.
            If ``null`` all stats till the deployment end forecast date will be cleaned
            up. Defaults to ``null``.
          format: date-time
          nullable: true
          type: string
        modelId:
          default: null
          description: ID of the model to remove deployment stats for. If ``null``,
            the stats will be cleaned up for all models in the mathcing period. Defaults
            to ``null``.
          nullable: true
          type: string
        start:
          description: If specified, the stats will be cleaned up from this timestamp.
            If ``null`` all stats from the deployment start forecast date will be
            cleaned up. Defaults to ``null``.
          format: date-time
          nullable: true
          type: string
      required:
      - dataType
      - end
      - modelId
      - start
      type: object
    DeploymentCreateFromLearningModel:
      properties:
        defaultPredictionServerId:
          description: ID of the default prediction server for deployment. Required
            for DataRobot Cloud, must be omitted for Enterprise installations.
          type: string
        description:
          default: null
          description: A description for the deployment.
          maxLength: 10000
          nullable: true
          type: string
        importance:
          description: Importance of the deployment. Defaults to LOW when MLOps is
            enabled, must not be provided when MLOps disabled.
          enum:
          - CRITICAL
          - HIGH
          - MODERATE
          - LOW
          nullable: true
          type: string
          x-versionadded: v2.21
        label:
          description: A human-readable name for the deployment.
          maxLength: 512
          type: string
        modelId:
          description: ID of the model to be deployed.
          type: string
        predictionThreshold:
          description: Prediction threshold used for binary classification. If not
            specified, model default prediction threshold will be used.
          maximum: 1.0
          minimum: 0.0
          type: number
        status:
          default: active
          description: Status of the deployment
          enum:
          - active
          - inactive
          nullable: true
          type: string
          x-versionadded: v2.23
      required:
      - description
      - label
      - modelId
      type: object
    DeploymentCreateResponse:
      properties:
        id:
          description: The ID of the created deployment.
          type: string
      required:
      - id
      type: object
    DeploymentCustomMetricsHealthResponse:
      properties:
        endDate:
          description: End date of custom metrics health period.
          format: date-time
          nullable: true
          type: string
        message:
          description: A message providing more detail on the status.
          type: string
        startDate:
          description: Start date of custom metrics health period.
          format: date-time
          nullable: true
          type: string
        status:
          description: "\n            Overall status of the deployment health based\
            \ of custom metrics health.\n\n              * ``unknown`` - used when\
            \ the deployment fairness status was never calculated.\n             \
            \ * ``passing`` - used when all fairness criteria are met.\n         \
            \     * ``warning`` - used when certain criteria are not met\n       \
            \                       but those are not critical for the user.\n   \
            \                           It is an intermediate status between ``passing``\
            \ and ``failing``.\n              * ``failing`` - used when critical criteria\
            \ are not met,\n                              indicating that the deployment\
            \ is failing fairness checks.\n            "
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    DeploymentDatasetCreate:
      properties:
        actualValueColumn:
          description: Column name that contains actual values.
          type: string
        associationIdColumn:
          description: Column name that contains unique identifiers used with a predicted
            rows.
          type: string
        datasetId:
          description: The ID of dataset from catalog.
          type: string
        datasetVersionId:
          description: Version of dataset to retrieve.
          nullable: true
          type: string
        keepActualsWithoutPredictions:
          default: true
          description: Indicates if actual without predictions are kept.
          type: boolean
        password:
          description: The password for database authentication.
          type: string
        timestampColumn:
          description: Column name that contain datetime when actual values were obtained.
          type: string
          x-versiondeprecated: v2.32
        user:
          description: The username for database authentication.
          type: string
        wasActedOnColumn:
          description: Column name that contains boolean values if any action was
            made based on predictions data.
          type: string
          x-versiondeprecated: v2.32
      required:
      - actualValueColumn
      - associationIdColumn
      - datasetId
      type: object
    DeploymentDefaultPredictionServerResponse:
      properties:
        datarobot-key:
          description: The `datarobot-key` header used in requests to this prediction
            server.
          type: string
        id:
          description: ID of the prediction server for the deployment.
          nullable: true
          type: string
        url:
          description: URL of the prediction server.
          type: string
      required:
      - datarobot-key
      - id
      - url
      type: object
    DeploymentDeleteChange:
      properties:
        defaultDeploymentId:
          description: Used by management agent to recalculate endpoint traffic. Traffic
            from the deploymentbeing deleted flipped to a default deployment.
          type: string
        ignoreManagementAgent:
          default: 'false'
          description: Do not wait for management agent to delete the deployment first.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      type: object
    DeploymentFairnessHealthResponse:
      properties:
        endDate:
          description: End date of fairness health period.
          format: date-time
          nullable: true
          type: string
        influentialFairnessMetric:
          description: Fairness metric with the most failing classes
          enum:
          - proportionalParity
          - equalParity
          - favorableClassBalance
          - unfavorableClassBalance
          - trueUnfavorableRateParity
          - trueFavorableRateParity
          - favorablePredictiveValueParity
          - unfavorablePredictiveValueParity
          nullable: true
          type: string
        messages:
          description: List of fairness status explanations
          items:
            description: A tooltip explaining the fairness status.
            type: string
          type: array
        protectedFeaturesCount:
          description: Count of the configured protected features for the deployment.
          maximum: 10
          minimum: 0
          type: integer
        startDate:
          description: Start date of fairness health period.
          format: date-time
          nullable: true
          type: string
        status:
          description: "\n            Overall status of the deployment health based\
            \ of calculated fairness scores.\n\n              * ``unknown`` - used\
            \ when the deployment fairness status was never calculated.\n        \
            \      * ``passing`` - used when all fairness criteria are met.\n    \
            \          * ``warning`` - used when certain criteria are not met\n  \
            \                            but those are not critical for the user.\n\
            \                              It is an intermediate status between ``passing``\
            \ and ``failing``.\n              * ``failing`` - used when critical criteria\
            \ are not met,\n                              indicating that the deployment\
            \ is failing fairness checks.\n            "
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - influentialFairnessMetric
      - messages
      - protectedFeaturesCount
      - startDate
      - status
      type: object
    DeploymentGovernanceResponse:
      properties:
        approvalStatus:
          description: Status to show whether the deployment was approved or not.
            It also shows up as a part of metadata within the prediction response.
          enum:
          - PENDING
          - APPROVED
          type: string
        hasOpenedChangeRequests:
          description: If there are change request related to this deployment with
            `PENDING` status.
          type: boolean
      required:
      - approvalStatus
      - hasOpenedChangeRequests
      type: object
    DeploymentListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of deployments.
          items:
            $ref: '#/components/schemas/DeploymentRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DeploymentModelCustomModelImageResponse:
      properties:
        customModelId:
          description: ID of the custom model.
          type: string
        customModelName:
          description: Name of the custom model.
          type: string
        customModelVersionId:
          description: ID of the custom model version.
          type: string
        customModelVersionLabel:
          description: Label of the custom model version.
          type: string
        executionEnvironmentId:
          description: ID of the execution environment.
          type: string
        executionEnvironmentName:
          description: Name of the execution environment.
          type: string
        executionEnvironmentVersionId:
          description: ID of the execution environment version.
          type: string
        executionEnvironmentVersionLabel:
          description: Label of the execution environment version.
          type: string
      required:
      - customModelId
      - customModelName
      - customModelVersionId
      - customModelVersionLabel
      - executionEnvironmentId
      - executionEnvironmentName
      - executionEnvironmentVersionId
      - executionEnvironmentVersionLabel
      type: object
    DeploymentModelHealthResponse:
      properties:
        endDate:
          description: End date of model health period.
          format: date-time
          nullable: true
          type: string
        message:
          description: A message providing more detail on the status.
          type: string
        startDate:
          description: Start date of model health period.
          format: date-time
          nullable: true
          type: string
        status:
          description: Model health status.
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    DeploymentModelPackageInitialDownloadResponse:
      properties:
        timestamp:
          description: Timestamp of the first time model package was downloaded.
          format: date-time
          nullable: true
          type: string
      required:
      - timestamp
      type: object
    DeploymentModelPackageResponse:
      properties:
        id:
          description: ID of the ModelPackage.
          type: string
        name:
          description: Name of the ModelPackage.
          type: string
        registeredModelId:
          description: The ID of the associated registered model
          nullable: true
          type: string
      required:
      - id
      - name
      - registeredModelId
      type: object
    DeploymentModelResponse:
      properties:
        buildEnvironmentType:
          description: Build environment type of the current model.
          nullable: true
          type: string
          x-versionadded: v2.21
        customModelImage:
          $ref: '#/components/schemas/DeploymentModelCustomModelImageResponse'
          description: Information related to the custom model image of the deployment.
        decisionFlowId:
          description: 'The ID of the decision flow if the deployment has one. '
          nullable: true
          type: string
        decisionFlowVersionId:
          description: 'The ID of the decision flow version if the deployment has
            one. '
          nullable: true
          type: string
        deployedAt:
          description: Timestamp of when current model was deployed.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.21
        hasDecisionFlow:
          description: True if this deployment contains a Decision Flow
          type: boolean
        id:
          description: ID of the current model.
          type: string
        isDeprecated:
          description: Whether the current model is deprecated model. eg. python2
            based model.
          type: boolean
          x-versionadded: v2.29
        projectId:
          description: Project ID of the current model.
          nullable: true
          type: string
        projectName:
          description: Project name of the current model.
          nullable: true
          type: string
        targetName:
          description: Target name of the current model.
          type: string
        targetType:
          description: Target type of the current model.
          type: string
        type:
          description: Type of the current model.
          type: string
        unstructuredModelKind:
          description: Whether the current model is an unstructured model.
          type: boolean
          x-versionadded: v2.29
        unsupervisedMode:
          description: Whether the current model's project is unsupervised.
          type: boolean
          x-versionadded: v2.18
        unsupervisedType:
          description: Only valid when unsupervisedMode is True. The type of unsupervised
            project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.23
      required:
      - id
      - isDeprecated
      - projectName
      - targetName
      - targetType
      - type
      - unstructuredModelKind
      - unsupervisedMode
      type: object
    DeploymentOwnerResponse:
      properties:
        email:
          description: Email address of the owner.
          nullable: true
          type: string
        firstName:
          description: First name of the owner.
          nullable: true
          type: string
        id:
          description: ID of the owner.
          type: string
        lastName:
          description: Last name of the owner.
          nullable: true
          type: string
      required:
      - email
      - firstName
      - id
      - lastName
      type: object
    DeploymentOwnersResponse:
      properties:
        count:
          description: Total count of owners.
          type: integer
        preview:
          description: A list of owner objects.
          items:
            $ref: '#/components/schemas/DeploymentOwnerResponse'
          type: array
      required:
      - count
      - preview
      type: object
    DeploymentPermanentDelete:
      properties:
        action:
          description: Action to perform on these deleted deployments.
          enum:
          - PermanentlyErase
          type: string
        deploymentIds:
          description: ID of a list of deleted deployments to perform action on.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
      required:
      - action
      - deploymentIds
      type: object
    DeploymentPredictionEnvironmentResponse:
      properties:
        id:
          description: ID of the PredictionEnvironment.
          nullable: true
          type: string
        isManagedByManagementAgent:
          description: True if PredictionEnvironment is using Management Agent.
          type: boolean
        name:
          description: Name of the PredictionEnvironment.
          type: string
        platform:
          description: Platform of the PredictionEnvironment.
          enum:
          - aws
          - gcp
          - azure
          - onPremise
          - datarobot
          - datarobotServerless
          - openShift
          - other
          - snowflake
          type: string
        plugin:
          description: Plugin name of the PredictionEnvironment.
          nullable: true
          type: string
        supportedModelFormats:
          description: Model formats that the PredictionEnvironment supports.
          items:
            enum:
            - datarobot
            - datarobotScoringCode
            - customModel
            - externalModel
            type: string
          maxItems: 4
          minItems: 1
          type: array
      required:
      - id
      - isManagedByManagementAgent
      - name
      - platform
      type: object
    DeploymentPredictionUsageResponse:
      properties:
        dailyRates:
          description: Number of predictions made in the last 7 days.
          items:
            type: integer
          type: array
        lastTimestamp:
          description: Timestamp of the last prediction request.
          format: date-time
          nullable: true
          type: string
      required:
      - dailyRates
      - lastTimestamp
      type: object
    DeploymentReplaceModelChange:
      properties:
        modelId:
          description: ID of the Model to deploy.
          type: string
        replacementReason:
          default: other
          description: Reason for replacement.
          enum:
          - accuracy
          - data_drift
          - errors
          - scheduled_refresh
          - scoring_speed
          - deprecation
          - other
          type: string
      required:
      - modelId
      - replacementReason
      type: object
    DeploymentReplaceModelPackageChange:
      properties:
        modelPackageId:
          description: ID of the Model Package to deploy.
          type: string
        replacementReason:
          default: other
          description: Reason for replacement.
          enum:
          - accuracy
          - data_drift
          - errors
          - scheduled_refresh
          - scoring_speed
          - deprecation
          - other
          type: string
      required:
      - modelPackageId
      - replacementReason
      type: object
    DeploymentRetrieveResponse:
      properties:
        accuracyHealth:
          $ref: '#/components/schemas/DeploymentAccuracyHealthResponse'
          description: Accuracy health of the deployment.
        approvalStatus:
          description: Status to show whether the deployment was approved or not.
            It also shows up as a part of metadata within the prediction response.
          enum:
          - PENDING
          - APPROVED
          type: string
        capabilities:
          $ref: '#/components/schemas/DeploymentCapabilitiesResponse'
          description: Capabilities of the deployment.
          x-versiondeprecated: v2.29
        createdAt:
          description: The date and time of when the deployment was created, in ISO
            8601 format.
          format: date-time
          type: string
          x-versionadded: v2.20
        defaultPredictionServer:
          $ref: '#/components/schemas/DeploymentDefaultPredictionServerResponse'
          description: The prediction server associated with the deployment.
          nullable: true
        description:
          description: Description of the deployment.
          nullable: true
          type: string
        governance:
          $ref: '#/components/schemas/DeploymentGovernanceResponse'
          description: Deployment governance info.
          x-versionadded: v2.21
        hasError:
          description: Whether the deployment is not operational because it failed
            to start properly.
          type: boolean
          x-versionadded: v2.32
        id:
          description: The ID of the deployment.
          type: string
        importance:
          description: Shows how important this deployment is.
          enum:
          - CRITICAL
          - HIGH
          - MODERATE
          - LOW
          type: string
          x-versionadded: v2.21
        label:
          description: Label of the deployment.
          maxLength: 512
          type: string
        model:
          $ref: '#/components/schemas/DeploymentModelResponse'
          description: Information related to the current model of the deployment.
        modelHealth:
          $ref: '#/components/schemas/DeploymentModelHealthResponse'
          description: Model health of the deployment.
        modelPackage:
          $ref: '#/components/schemas/DeploymentModelPackageResponse'
          description: Information related to the current ModelPackage.
          x-versionadded: v2.23
        modelPackageInitialDownload:
          $ref: '#/components/schemas/DeploymentModelPackageInitialDownloadResponse'
          description: If a model package has been downloaded for this deployment,
            then this will tell you when it was first downloaded.
          x-versionadded: v2.23
        openedChangeRequests:
          description: An array of the change request IDs related to this deployment
            that have.
          items:
            type: string
          type: array
        owners:
          $ref: '#/components/schemas/DeploymentOwnersResponse'
          description: Count and preview of owners of the deployment.
        permissions:
          description: Permissions that the user making the request has on the deployment.
          items:
            enum:
            - CAN_ADD_CHALLENGERS
            - CAN_APPROVE_REPLACEMENT_MODEL
            - CAN_BE_MANAGED_BY_MLOPS_AGENT
            - CAN_DELETE_CHALLENGERS
            - CAN_DELETE_DEPLOYMENT
            - CAN_DOWNLOAD_DOCUMENTATION
            - CAN_EDIT_CHALLENGERS
            - CAN_EDIT_DEPLOYMENT
            - CAN_GENERATE_DOCUMENTATION
            - CAN_MAKE_PREDICTIONS
            - CAN_REPLACE_MODEL
            - CAN_SCORE_CHALLENGERS
            - CAN_SHARE
            - CAN_SHARE_DEPLOYMENT_OWNERSHIP
            - CAN_SUBMIT_ACTUALS
            - CAN_UPDATE_DEPLOYMENT_THRESHOLDS
            - CAN_VIEW
            type: string
          type: array
          x-versionadded: v2.18
        predictionEnvironment:
          $ref: '#/components/schemas/DeploymentPredictionEnvironmentResponse'
          description: Information related to the current PredictionEnvironment.
          nullable: true
          x-versionadded: v2.23
        predictionUsage:
          $ref: '#/components/schemas/DeploymentPredictionUsageResponse'
          description: Prediction usage of the deployment.
        scoringCodeInitialDownload:
          $ref: '#/components/schemas/DeploymentScoringCodeInitialDownloadResponse'
          description: If scoring code has been downloaded for this deployment, then
            this will tell you when it was first downloaded.
          x-versionadded: v2.21
        serviceHealth:
          $ref: '#/components/schemas/DeploymentServiceHealthResponse'
          description: Service health of the deployment.
        settings:
          $ref: '#/components/schemas/DeploymentSettingsInfo'
          description: Settings of the deployment.
          x-versionadded: v2.21
        status:
          description: Displays current deployment status.
          enum:
          - active
          - archived
          - errored
          - inactive
          - launching
          - replacingModel
          - stopping
          type: string
          x-versionadded: v2.22
        tags:
          description: The list of formatted deployment tags.
          items:
            $ref: '#/components/schemas/DeploymentTagRetrieveResponse'
          type: array
        userProvidedId:
          description: A user-provided unique ID associated with a deployment definition
            in a remote git repository.
          maxLength: 100
          type: string
          x-versionadded: v2.29
      required:
      - accuracyHealth
      - capabilities
      - createdAt
      - defaultPredictionServer
      - description
      - id
      - label
      - model
      - modelHealth
      - permissions
      - predictionUsage
      - serviceHealth
      - settings
      - status
      - tags
      type: object
    DeploymentScoringCodeInitialDownloadResponse:
      properties:
        timestamp:
          description: Timestamp of the first time scoring code was downloaded.
          format: date-time
          nullable: true
          type: string
      required:
      - timestamp
      type: object
    DeploymentSecondaryDataset:
      properties:
        catalogId:
          description: ID of the catalog item
          type: string
        catalogVersionId:
          description: ID of the catalog version
          type: string
        identifier:
          description: Short name of this table (used directly as part of generated
            feature names)
          maxLength: 45
          minLength: 1
          type: string
        snapshotPolicy:
          description: Policy to use by a dataset while making prediction
          enum:
          - specified
          - latest
          - dynamic
          type: string
      required:
      - catalogId
      - catalogVersionId
      - identifier
      - snapshotPolicy
      type: object
    DeploymentServiceHealthResponse:
      properties:
        endDate:
          description: End date of model service period.
          format: date-time
          nullable: true
          type: string
        startDate:
          description: Start date of service health period.
          format: date-time
          nullable: true
          type: string
        status:
          description: Service health status.
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - startDate
      - status
      type: object
    DeploymentSettingsInfo:
      properties:
        batchMonitoringEnabled:
          description: if batch monitoring is enabled.
          type: boolean
        humbleAiEnabled:
          description: if humble ai is enabled.
          type: boolean
        predictionIntervalsEnabled:
          description: If  prediction intervals are enabled.
          type: boolean
        predictionWarningEnabled:
          description: If prediction warning is enabled.
          type: boolean
      type: object
    DeploymentSettingsResponse:
      properties:
        associationId:
          $ref: '#/components/schemas/AssociationID'
          description: The association ID setting for the deployment.
          x-versionadded: v2.19
        automaticActuals:
          $ref: '#/components/schemas/AutomatiActuals'
          description: Automatic actuals setting for the deployment.
          x-versionadded: v2.25
        biasAndFairness:
          $ref: '#/components/schemas/BiasAndFairness'
          description: Bias and fairness setting for the deployment.
          x-versionadded: v2.31
        challengerModels:
          $ref: '#/components/schemas/Challengers'
          description: Challenger models setting for the deployment.
          x-versionadded: v2.23
        featureDrift:
          $ref: '#/components/schemas/FeatureDriftSetting'
          description: The feature drift setting for the deployment.
        humility:
          $ref: '#/components/schemas/Humility'
          description: Humility setting for the deployment.
          x-versionadded: v2.21
        predictionIntervals:
          $ref: '#/components/schemas/PredictionIntervals'
          description: The prediction intervals setting for the deployment.
          x-versionadded: v2.19
        predictionWarning:
          $ref: '#/components/schemas/PredictionWarning'
          description: The prediction warning setting for the deployment.
          x-versionadded: v2.19
        predictionsByForecastDate:
          $ref: '#/components/schemas/ForecastDate'
          description: Forecast date setting for the deployment.
          x-versionadded: v2.23
        predictionsDataCollection:
          $ref: '#/components/schemas/PredictionsDataCollection'
          description: The predictions data collection setting for the deployment.
          x-versionadded: v2.19
        segmentAnalysis:
          $ref: '#/components/schemas/SegmentAnalysis'
          description: The segment analysis setting for the deployment.
          x-versionadded: v2.20
        targetDrift:
          $ref: '#/components/schemas/TargetDriftSetting'
          description: The target drift setting for the deployment.
      required:
      - associationId
      - featureDrift
      - predictionIntervals
      - targetDrift
      type: object
    DeploymentSettingsUpdate:
      properties:
        associationId:
          $ref: '#/components/schemas/AssociationIDUpdate'
          description: Association id settings for the deployment.
          x-versionadded: v2.19
        automaticActuals:
          $ref: '#/components/schemas/AutomatiActuals'
          description: Automatic actuals setting for the deployment.
          x-versionadded: v2.25
        biasAndFairness:
          $ref: '#/components/schemas/BiasAndFairness'
          description: Bias and fairness setting for the deployment.
          nullable: true
          x-versionadded: v2.31
        challengerModels:
          $ref: '#/components/schemas/Challengers'
          description: Challenger models setting for the deployment.
          x-versionadded: v2.23
        featureDrift:
          $ref: '#/components/schemas/FeatureDriftUpdate'
          description: Feature drift setting for the deployment.
        humility:
          $ref: '#/components/schemas/Humility'
          description: Humility setting for the deployment.
          x-versionadded: v2.21
        predictionIntervals:
          $ref: '#/components/schemas/PredictionIntervalsUpdate'
          description: Prediction intervals setting for the deployment. Requires that
            the requested interval size is calculated prior to setting in this request.
          x-versionadded: v2.19
        predictionWarning:
          $ref: '#/components/schemas/PredictionWarningUpdate'
          description: Prediction warning setting for the deployment.
          x-versionadded: v2.19
        predictionsByForecastDate:
          $ref: '#/components/schemas/ForecastDate'
          description: Forecast date setting for the deployment.
          x-versionadded: v2.23
        predictionsDataCollection:
          $ref: '#/components/schemas/PredictionsDataCollection'
          description: The predictions data collection setting for the deployment.
          x-versionadded: v2.19
        segmentAnalysis:
          $ref: '#/components/schemas/SegmentAnalysisUpdate'
          description: The segment analysis setting for the deployment.
          x-versionadded: v2.20
        targetDrift:
          $ref: '#/components/schemas/TargetDriftUpdate'
          description: Target drift setting for the deployment.
      type: object
    DeploymentStatusUpdate:
      properties:
        status:
          description: Status that deployment should be transition in.
          enum:
          - active
          - inactive
          type: string
      required:
      - status
      type: object
    DeploymentTagRetrieveResponse:
      properties:
        id:
          description: The ID of the tag.
          type: string
        name:
          description: The name of the tag.
          maxLength: 50
          type: string
        value:
          description: The value of the tag.
          maxLength: 50
          type: string
      required:
      - id
      - name
      - value
      type: object
    DeploymentUpdate:
      properties:
        description:
          description: A description for the deployment.
          maxLength: 10000
          nullable: true
          type: string
        importance:
          description: Shows how important this deployment is.
          enum:
          - CRITICAL
          - HIGH
          - MODERATE
          - LOW
          type: string
          x-versionadded: v2.21
        label:
          description: A human-readable name for the deployment.
          maxLength: 512
          nullable: true
          type: string
      type: object
    DeploymentUpdateSecondaryDatasetConfigChange:
      properties:
        secondaryDatasetsConfigId:
          description: ID of the secondary dataset configs.
          type: string
      required:
      - secondaryDatasetsConfigId
      type: object
    DeploymentsScoringCodeBuildPayload:
      properties:
        includeAgent:
          description: Whether the Scoring Code built will include tracking agent
          type: boolean
        includePredictionExplanations:
          description: Whether the Scoring Code built will include prediction explanations
          type: boolean
        includePredictionIntervals:
          description: Whether the Scoring Code built will include prediction intervals
          type: boolean
      type: object
    DeprecatedCustomModelVersionTrainingDataUpdate:
      properties:
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          description: Contains git related attributes that are associated with a
            custom model version.
          x-versionadded: v2.31
        holdoutData:
          $ref: '#/components/schemas/DeprecatedHoldoutDataAssignment'
          description: Holdout data configuration.
          nullable: true
          x-versionadded: v2.30
          x-versiondeprecated: v2.33
        trainingData:
          $ref: '#/components/schemas/DeprecatedTrainingDataForVersionsAssignment'
          description: Training data configuration.
          nullable: true
          x-versionadded: v2.30
          x-versiondeprecated: v2.33
      required:
      - trainingData
      type: object
    DeprecatedCustomModelWorkspaceItemResponse:
      properties:
        commitSha:
          description: SHA1 hash pointing to the original file revision (set only
            for files pulled from Git-like repositories).
          nullable: true
          type: string
        created:
          description: ISO-8601 timestamp of when the file item was created.
          type: string
        fileName:
          description: Name of the file item.
          type: string
        filePath:
          description: Path of the file item.
          type: string
        fileSource:
          description: Source of the file item.
          type: string
        id:
          description: ID of the file item.
          type: string
        ref:
          description: Remote reference (branch, commit, tag). Branch "master", if
            not specified.
          nullable: true
          type: string
        repositoryFilePath:
          description: Full path to the file in the remote repository.
          nullable: true
          type: string
        repositoryLocation:
          description: URL to remote repository from which the file was pulled (e.g.
            Git server or S3 Bucket name).
          nullable: true
          type: string
        repositoryName:
          description: Name of the repository from which the file was pulled.
          nullable: true
          type: string
        storagePath:
          description: Storage path of the file item.
          type: string
          x-versiondeprecated: '2.25'
        workspaceId:
          description: Workspace ID of the file item.
          type: string
          x-versiondeprecated: '2.25'
      required:
      - created
      - fileName
      - filePath
      - fileSource
      - id
      - storagePath
      - workspaceId
      type: object
    DeprecatedHoldoutDataAssignment:
      properties:
        datasetId:
          description: The ID of the dataset.
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        datasetVersionId:
          description: The ID of the dataset version.
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        partitionColumn:
          description: The name of the column containing the partition assignments.
          maxLength: 500
          nullable: true
          type: string
          x-versiondeprecated: v2.33
      type: object
    DeprecatedTrainingDataForModelsAssignment:
      properties:
        datasetId:
          description: The ID of the dataset.
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        datasetVersionId:
          description: The ID of the dataset version.
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        partitionColumn:
          description: The name of the column containing the partition assignments.
          maxLength: 500
          nullable: true
          type: string
          x-versiondeprecated: v2.34
      type: object
    DeprecatedTrainingDataForVersionsAssignment:
      properties:
        assignmentInProgress:
          default: false
          description: Indicates if training data is currently being assigned to the
            custom model. Only for structured models.
          type: boolean
          x-versiondeprecated: v2.33
        datasetId:
          description: The ID of the dataset.
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          nullable: true
          type: string
          x-versiondeprecated: v2.34
        datasetVersionId:
          description: The ID of the dataset version.
          nullable: true
          type: string
          x-versiondeprecated: v2.34
      type: object
    DerivedFeatures:
      properties:
        coefficient:
          description: The coefficient for this feature.
          type: number
        derivedFeature:
          description: The name of the derived feature.
          type: string
        originalFeature:
          description: The name of the feature used to derive this feature.
          type: string
        stageCoefficients:
          description: An array of json objects describing separate coefficients for
            every stage of model (empty for single stage models).
          items:
            $ref: '#/components/schemas/StageCoefficients'
          type: array
        transformations:
          description: An array of json objects describing the transformations applied
            to create this derived feature.
          items:
            $ref: '#/components/schemas/Transformations'
          type: array
        type:
          description: The type of this feature.
          type: string
      required:
      - coefficient
      - derivedFeature
      - originalFeature
      - stageCoefficients
      - transformations
      - type
      type: object
    DiscardedFeaturesResponse:
      properties:
        count:
          description: Discarded features count.
          minimum: 0
          type: integer
        features:
          description: Discarded features.
          items:
            type: string
          type: array
        remainingRestoreLimit:
          description: The remaining available number of the features which can be
            restored in this project.
          minimum: 0
          type: integer
        totalRestoreLimit:
          description: The total limit indicating how many features can be restored
            in this project.
          minimum: 0
          type: integer
      required:
      - count
      - features
      - remainingRestoreLimit
      - totalRestoreLimit
      type: object
    DocTypeSpecificInfoDeploymentReport:
      properties:
        endDate:
          description: End date of selected data in the document.
          format: date-time
          type: string
        modelName:
          description: Name of the deployed model.
          type: string
        startDate:
          description: Start date of selected data in the document.
          format: date-time
          type: string
      required:
      - endDate
      - startDate
      type: object
    DocTypeSpecificInfoModelCompliance:
      type: object
    DocumentFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          nullable: true
          type: number
        featureName:
          description: Feature name.
          type: string
        featureType:
          description: Feature Type.
          enum:
          - document
          type: string
        insights:
          description: A list of Cluster Insights for a feature.
          items:
            $ref: '#/components/schemas/Text'
          type: array
      required:
      - featureName
      - featureType
      - insights
      type: object
    DocumentTextExtractionDocumentElement:
      properties:
        actualTargetValue:
          description: Actual target value of the dataset row
          nullable: true
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
        documentIndex:
          description: The index of the document within the dataset.
          type: integer
        documentTask:
          description: The document task this document belongs to.
          enum:
          - DOCUMENT_TEXT_EXTRACTOR
          - TESSERACT_OCR
          type: string
        featureName:
          description: The name of the feature.
          type: string
        prediction:
          $ref: '#/components/schemas/InsightsPredictionField'
          description: Object that describes prediction value of the dataset row.
          nullable: true
        thumbnailHeight:
          description: The height of the thumbnail in pixels.
          type: integer
        thumbnailId:
          description: The document page ID of the thumbnail.
          type: string
        thumbnailLink:
          description: The URL of the thumbnail image.
          format: uri
          type: string
        thumbnailWidth:
          description: The width of the thumbnail in pixels.
          type: integer
      required:
      - actualTargetValue
      - documentIndex
      - documentTask
      - featureName
      - prediction
      - thumbnailHeight
      - thumbnailId
      - thumbnailLink
      - thumbnailWidth
      type: object
    DocumentTextExtractionPagesElement:
      properties:
        actualTargetValue:
          description: Actual target value of the dataset row
          nullable: true
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
        documentIndex:
          description: The index of the document within the dataset.
          type: integer
        documentPageHeight:
          description: The height of the thumbnail in pixels.
          type: integer
        documentPageId:
          description: The document page ID of the thumbnail.
          type: string
        documentPageLink:
          description: The URL of the thumbnail image.
          format: uri
          type: string
        documentPageWidth:
          description: The width of the thumbnail in pixels.
          type: integer
        documentTask:
          description: The document task that this page belongs to.
          enum:
          - DOCUMENT_TEXT_EXTRACTOR
          - TESSERACT_OCR
          type: string
        featureName:
          description: The name of the feature.
          type: string
        pageIndex:
          description: The index of this page within the document
          type: integer
        prediction:
          $ref: '#/components/schemas/InsightsPredictionField'
          description: Object that describes prediction value of the dataset row.
          nullable: true
        textLines:
          description: The recognized text lines of this document page with bounding
            box coordinates for each text line.
          items:
            $ref: '#/components/schemas/TextLine'
          type: array
      required:
      - actualTargetValue
      - documentIndex
      - documentPageHeight
      - documentPageId
      - documentPageLink
      - documentPageWidth
      - documentTask
      - featureName
      - pageIndex
      - prediction
      - textLines
      type: object
    DocumentTextExtractionSampleMetadataElement:
      properties:
        documentTask:
          description: The document task that this data belongs to.
          enum:
          - DOCUMENT_TEXT_EXTRACTOR
          - TESSERACT_OCR
          type: string
        featureName:
          description: Name of feature
          type: string
        modelId:
          description: The model ID of the target model.
          type: string
      required:
      - documentTask
      - featureName
      - modelId
      type: object
    DocumentTextExtractionSamplesComputeResponse:
      properties:
        id:
          description: The job ID.
          type: string
        isBlocked:
          description: True if the job is waiting for its dependencies to be resolved
            first.
          type: boolean
        jobType:
          description: The type of the job.
          enum:
          - compute_document_text_extraction_samples
          type: string
        message:
          description: Error message in case of failure.
          type: string
        modelId:
          description: The model ID of the target model.
          type: string
        projectId:
          description: The project the job belongs to.
          type: string
        status:
          description: The job status.
          enum:
          - queue
          - inprogress
          - error
          - ABORTED
          - COMPLETED
          type: string
        url:
          description: A URL that can be used to request details about the job.
          type: string
      required:
      - id
      - isBlocked
      - jobType
      - message
      - modelId
      - projectId
      - status
      - url
      type: object
    DocumentTextExtractionSamplesListMetadataResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of Model ID feature name pairs with computed document
            text extraction samples.
          items:
            $ref: '#/components/schemas/DocumentTextExtractionSampleMetadataElement'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DocumentTextExtractionSamplesRetrieveDocumentsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of documents.
          items:
            $ref: '#/components/schemas/DocumentTextExtractionDocumentElement'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        targetBins:
          description: List of bin objects for regression or null
          items:
            $ref: '#/components/schemas/TargetBin'
          nullable: true
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          nullable: true
          type: array
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - targetBins
      - targetValues
      - totalCount
      type: object
    DocumentTextExtractionSamplesRetrievePagesResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of document pages
          items:
            $ref: '#/components/schemas/DocumentTextExtractionPagesElement'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        targetBins:
          description: List of bin objects for regression or null
          items:
            $ref: '#/components/schemas/TargetBin'
          nullable: true
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          nullable: true
          type: array
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - targetBins
      - targetValues
      - totalCount
      type: object
    DocumentThumbnailBinsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of document thumbnail metadata, as described below
          items:
            $ref: '#/components/schemas/DocumentThumbnailMetadataWithBins'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DocumentThumbnailMetadataListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of document thumbnail metadata elements
          items:
            $ref: '#/components/schemas/DocumentThumbnailMetadataResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DocumentThumbnailMetadataResponse:
      properties:
        documentPageId:
          description: The ID of the document page. The actual document page can be
            retrieved with :http:get:`/api/v2/projects/(projectId)/documentPages/(documentPageId)/file/`.
          type: string
        height:
          description: The height of the document page in pixels.
          type: integer
        targetValue:
          description: Target value
          oneOf:
          - description: For regression projects
            type: number
          - description: For classification projects
            type: string
          - items:
              description: For multilabel projects
              type: string
            type: array
        width:
          description: The width of the document page in pixels.
          type: integer
      required:
      - documentPageId
      - height
      - width
      type: object
    DocumentThumbnailMetadataWithBins:
      properties:
        documentPageId:
          description: The ID of the document page. The actual document page can be
            retrieved with :http:get:`/api/v2/projects/(projectId)/documentPages/(documentPageId)/file/`.
          type: string
        height:
          description: The height of the document page in pixels.
          type: integer
        targetBinEnd:
          description: Target value for bin end for regression, null for classification
          nullable: true
          type: integer
        targetBinRowCount:
          description: The number of rows in the target bin.
          type: integer
        targetBinStart:
          description: Target value for bin start for regression, null for classification
          nullable: true
          type: integer
        targetValue:
          description: Target value
          oneOf:
          - description: For regression projects
            type: number
          - description: For classification projects
            type: string
          - items:
              description: For multilabel projects
              type: string
            type: array
        width:
          description: The width of the document page in pixels.
          type: integer
      required:
      - documentPageId
      - height
      - targetBinRowCount
      - width
      type: object
    DocumentsDataQualityLogLinesResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: The content in the form of lines of the documents data quality
            log
          items:
            description: Log lines
            type: string
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DownsamplingRandomDirectiveArguments:
      properties:
        rows:
          description: The number of sampled rows.
          type: integer
          x-versionadded: v2.33
        seed:
          default: null
          description: The start number of the random number generator
          nullable: true
          type: integer
          x-versionadded: v2.33
      required:
      - rows
      type: object
    DriftBatch:
      properties:
        earliestPredictionTimestamp:
          description: Earliest prediction timestamp of a batch.
          format: date-time
          type: string
          x-versionadded: v2.33
        id:
          description: Batch ID.
          type: string
          x-versionadded: v2.33
        latestPredictionTimestamp:
          description: Latest prediction timestamp of a batch.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: Batch name.
          type: string
          x-versionadded: v2.33
      required:
      - earliestPredictionTimestamp
      - id
      - latestPredictionTimestamp
      - name
      type: object
    DriverConfigurationListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of driver configurations available to the user.
          items:
            $ref: '#/components/schemas/DriverConfigurationRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DriverConfigurationRetrieveResponse:
      properties:
        associatedAuthTypes:
          description: List of authentication types supported by this driver configuration.
          items:
            type: string
          type: array
        className:
          description: Java class name of the driver to be used (e.g., org.postgresql.Driver).
          type: string
        creator:
          description: User ID of the creator of this configuration.
          type: string
        id:
          description: Driver configuration ID
          type: string
        jdbcFieldSchemas:
          description: Description of which fields to show when creating a datastore,
            their defaults, and whether or not they are required.
          items:
            $ref: '#/components/schemas/JDBCFieldSchemas'
          type: array
        jdbcUrlPathDelimiter:
          description: Separator of address from path in the JDBC URL (e.g., "/").
          type: string
        jdbcUrlPrefix:
          description: Prefix of the JDBC URL (e.g., "jdbc:mssql://" or "jdbc:oracle:thin:@").
          type: string
        jdbcUrlQueryDelimiter:
          description: Separator of path from the list of query parameters in the
            JDBC URL (e.g., "?").
          type: string
        jdbcUrlQueryParamDelimiter:
          description: Separator of each set of query parameter key-value pairs in
            the JDBC URL (e.g., "&").
          type: string
        jdbcUrlQueryParamKeyValueDelimiter:
          description: Separator of the key and value in a query parameter pair (e.g.,
            "=").
          type: string
        standardizedName:
          description: Plain text name for the driver (e.g., PostgreSQL).
          type: string
        statements:
          description: List of supported statments for this driver configuration.
          items:
            enum:
            - insert
            - update
            - upsert
            type: string
          type: array
        updated:
          description: ISO-8601 formatted time/date when this configuration was most
            recently updated.
          type: string
      required:
      - associatedAuthTypes
      - className
      - creator
      - id
      - jdbcFieldSchemas
      - jdbcUrlPathDelimiter
      - jdbcUrlPrefix
      - jdbcUrlQueryDelimiter
      - jdbcUrlQueryParamDelimiter
      - jdbcUrlQueryParamKeyValueDelimiter
      - standardizedName
      - updated
      type: object
    DriverListResponse:
      properties:
        data:
          description: List of drivers.
          items:
            $ref: '#/components/schemas/DriverResponse'
          type: array
      required:
      - data
      type: object
    DriverResponse:
      properties:
        associatedAuthTypes:
          description: Authentication types associated with this connector configuration.
          items:
            enum:
            - basic
            - googleOauthUserAccount
            - snowflakeKeyPairUserAccount
            - snowflakeOauthUserAccount
            type: string
          type: array
        baseNames:
          description: Original file name(s) of the uploaded JAR file(s). If there
            are multiple JAR files required for the driver, each of the original file
            names should be present in the list in the same order as found in 'localJarUrls'
          items:
            description: Original file name of the uploaded JAR file.
            type: string
          nullable: true
          type: array
        canonicalName:
          description: User-friendly driver name.
          type: string
        className:
          description: Driver class name. For example 'com.amazon.redshift.jdbc.Driver'
          nullable: true
          type: string
        configurationId:
          description: Driver configuration ID if it was provided during driver upload.
          nullable: true
          type: string
          x-versionadded: v2.18
        creator:
          description: ID of the user who uploaded the driver.
          type: string
        databaseDriver:
          description: The type of database of the driver. Only required of 'dr-database-v1'
            drivers.
          enum:
          - bigquery-v1
          - databricks-v1
          nullable: true
          type: string
          x-versionadded: v2.30
        id:
          description: Driver ID.
          type: string
        type:
          default: jdbc
          description: Driver type. Either 'jdbc' or 'dr-database-v1'.
          enum:
          - dr-database-v1
          - jdbc
          type: string
          x-versionadded: v2.30
        version:
          description: Driver version, which is used to construct the canonical name
            if driver configuration ID was provided during driver upload.
          type: string
          x-versionadded: v2.18
      required:
      - creator
      - id
      type: object
    DriverUploadRequest:
      properties:
        file:
          description: JDBC driver JAR file to upload.
          format: binary
          type: string
      required:
      - file
      type: object
    DriverUploadResponse:
      properties:
        localUrl:
          description: URL of uploaded driver file.
          type: string
      required:
      - localUrl
      type: object
    DropColumnsArguments:
      properties:
        columns:
          description: The list of columns.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - columns
      type: object
    DuplicateImageItem:
      properties:
        imageId:
          description: Id of the image. The actual image file can be retrieved with
            :http:get:`/api/v2/projects/(projectId)/images/(imageId)/file/`
          type: string
        rowCount:
          description: The count of duplicate images i.e. number of times this image
            is used in column
          type: integer
      required:
      - imageId
      - rowCount
      type: object
    DuplicateImageTableResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of image metadata
          items:
            $ref: '#/components/schemas/DuplicateImageItem'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    EmbeddingsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of Image Embeddings
          items:
            $ref: '#/components/schemas/ImageInsightsMetadataElement'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    EmbeddingsRetrieveResponse:
      properties:
        embeddings:
          description: List of Image Embedding objects
          items:
            $ref: '#/components/schemas/ImageEmbedding'
          type: array
        targetBins:
          description: List of bin objects for regression or null
          items:
            $ref: '#/components/schemas/TargetBin'
          nullable: true
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          nullable: true
          type: array
      required:
      - embeddings
      - targetBins
      - targetValues
      type: object
    Empty:
      type: object
    EnhancedEncryptionKeypairs:
      properties:
        cert_file:
          description: Path to the pem file with a single certificate.
          type: string
        cert_file_value:
          description: A single certificate pem file content as a single string. Has
            priority over cert_file.
          type: string
        key_file:
          description: Path to the private key pem file.
          type: string
        key_file_value:
          description: The private key pem file content as a single string. Has priority
            over key_file.
          type: string
      type: object
    EnhancedSamlAttributeMapping:
      properties:
        displayName:
          description: Display name.
          type: string
        email:
          description: Email.
          type: string
        firstName:
          description: First name.
          type: string
        group:
          description: Group.
          type: string
        impersonationUser:
          description: Impersonation user.
          type: string
        lastName:
          description: Last name.
          type: string
        role:
          description: Role.
          type: string
        username:
          description: Username.
          type: string
      type: object
    EnhancedSamlClientConfig:
      properties:
        cert_file:
          description: Path to the pem file with a single certificate.
          type: string
        cert_file_value:
          description: A single certificate pem file content as a single string. Has
            priority over cert_file.
          type: string
        encryption_keypairs:
          description: Indicates which certificates will be used for encryption capabilities.
          items:
            $ref: '#/components/schemas/EnhancedEncryptionKeypairs'
          type: array
        id_attr_name:
          description: Attribute is required to be set to 'Id' value when Okta encrypted
            assertions are used
          type: string
        id_attr_name_crypto:
          description: Attribute is required to be set to 'Id' value when Okta encrypted
            assertions are used
          type: string
        key_file:
          description: Path to the private key pem file.
          type: string
        key_file_value:
          description: The private key pem file content as a single string. Has priority
            over key_file.
          type: string
      type: object
    EnhancedSamlGroupMapping:
      properties:
        datarobotGroupId:
          description: DataRobot group ID.
          type: string
        idpGroupId:
          description: Name of the identity provider group
          type: string
      required:
      - datarobotGroupId
      - idpGroupId
      type: object
    EnhancedSamlRoleMapping:
      properties:
        datarobotRoleId:
          description: DataRobot access role ID.
          type: string
        idpRoleId:
          description: Name of the identity provider role.
          type: string
      required:
      - datarobotRoleId
      - idpRoleId
      type: object
    EnhancedSsoConfigurationResponse:
      properties:
        attributeMapping:
          $ref: '#/components/schemas/EnhancedSamlAttributeMapping'
          description: Attribute mapping between DataRobot and IdP.
        autoGenerateUsers:
          description: Determines if DataRobot automatically creates an account on
            first successful login via IdP if the user doesn't exist in the DataRobot
            application.
          type: boolean
        certificate:
          $ref: '#/components/schemas/SamlCertificate'
          description: Certificate to be used by IdP.
        configurationType:
          description: "The type of the SSO configuration, defines the source of SSO\
            \ metadata.\n            It can be one of the following: `METADATA` -\
            \ when IDP metadata is provided in the\n            config, `METADATA_URL`\
            \ - when an URL for metadata retrieval is provided in the config and\n\
            \            `MANUAL` - when IDP sign-on/sign-out URLs and certificate\
            \ are provided."
          enum:
          - MANUAL
          - METADATA
          - METADATA_URL
          type: string
        enableSso:
          description: Defines if SSO is enabled.
          type: boolean
        enforceSso:
          description: Defines if SSO is enforced.
          type: boolean
        entityId:
          description: The globally unique identifier of the entity. Provided by IdP
            service.
          type: string
        groupDelimiter:
          description: A delimiter used to split IdP provided Group assertions if
            provided as a singledelimiter-separated list.
          type: string
        groupMapping:
          description: The list of DataRobot group to identity provider group maps.
          items:
            $ref: '#/components/schemas/SamlGroupMappingResponse'
          type: array
        id:
          description: SSO configuration ID.
          type: string
        idpMetadata:
          $ref: '#/components/schemas/SamlMetadataFile'
          description: XML document, IdP SSO descriptor. Provided by IdP service.
          nullable: true
        idpMetadataHttpsVerify:
          description: "When idp_metadata_url uses HTTPS, require the server to have\
            \ a trusted certificate.\n            To avoid security vulnerabilities,\
            \ only set to False when a trusted server has a\n            self-signed\
            \ certificate."
          type: boolean
        idpMetadataUrl:
          description: URL to the IdP SSO descriptor. Provided by IdP service.
          format: uri
          type: string
        idpResponseMethod:
          default: POST
          description: Identity provider response method, used to move user from IdP's
            authentication form back to the DataRobot side.
          enum:
          - POST
          - REDIRECT
          type: string
        issuer:
          description: Optional Issuer field that may be required by IdP.
          nullable: true
          type: string
        name:
          description: The name of the SSO configuration.
          type: string
        organizationId:
          description: The organization ID to which the SSO config belongs.
          type: string
        roleDelimiter:
          description: A delimiter used to split IdP provided Role assertions if provided
            as a singledelimiter-separated list.
          type: string
        roleMapping:
          description: The list of DataRobot access role to identity provider role
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlRoleMapping'
          type: array
        securityParameters:
          $ref: '#/components/schemas/SamlSecurityParameters'
          description: The object that contains SAML specific directives.
        sessionLengthSeconds:
          default: 604800
          description: Time window for the authentication session via IDP
          exclusiveMinimum: true
          minimum: 0
          type: integer
        signOnUrl:
          description: URL to sign on via SSO.
          format: uri
          type: string
        signOutUrl:
          description: URL to sign out via SSO.
          format: uri
          type: string
        spRequestMethod:
          default: REDIRECT
          description: Service provider (DataRobot application) request method, is
            used to move user to the IdP's authentication form.
          enum:
          - POST
          - REDIRECT
          type: string
      required:
      - configurationType
      - enableSso
      - enforceSso
      - entityId
      - id
      - idpResponseMethod
      - name
      - sessionLengthSeconds
      - spRequestMethod
      type: object
    EntityCountByTypeResponse:
      properties:
        numCalendars:
          description: The number of calendars that use the dataset
          type: integer
        numExternalModelPackages:
          description: The number of external model packages that use the dataset
          type: integer
        numFeatureDiscoveryConfigs:
          description: The number of feature discovery configs that use the dataset
          type: integer
        numPredictionDatasets:
          description: The number of prediction datasets that use the dataset
          type: integer
        numProjects:
          description: The number of projects that use the dataset
          type: integer
        numSparkSqlQueries:
          description: The number of spark sql queries that use the dataset
          type: integer
      required:
      - numCalendars
      - numExternalModelPackages
      - numFeatureDiscoveryConfigs
      - numPredictionDatasets
      - numProjects
      - numSparkSqlQueries
      type: object
    EntityNotificationChannel:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - DataRobotCustomJob
          - DataRobotGroup
          - DataRobotUser
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
          x-versionadded: v2.33
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          nullable: true
          type: string
          x-versionadded: v2.33
        createdAt:
          description: The date of the notification channel creation.
          format: date-time
          type: string
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          nullable: true
          type: array
          x-versionadded: v2.33
        drEntities:
          description: The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup
            channel types.
          items:
            $ref: '#/components/schemas/ChannelDREntity'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: The id of the notification channel.
          type: string
          x-versionadded: v2.33
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of organization that notification channel belongs to.
          nullable: true
          type: string
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          nullable: true
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          nullable: true
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          nullable: true
          type: boolean
          x-versionadded: v2.33
      required:
      - channelType
      - contentType
      - createdAt
      - customHeaders
      - emailAddress
      - id
      - languageCode
      - name
      - orgId
      - payloadUrl
      - secretToken
      - uid
      - updatedAt
      - validateSsl
      type: object
    EntityNotificationChannelCreate:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - DataRobotCustomJob
          - DataRobotGroup
          - DataRobotUser
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
          x-versionadded: v2.33
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          type: string
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          type: array
          x-versionadded: v2.33
        drEntities:
          description: The IDs of the DataRobot Users, Group or Custom Job associated
            with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
          items:
            $ref: '#/components/schemas/DREntity'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          type: string
          x-versionadded: v2.33
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          maxLength: 100
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of organization that notification channel belongs to.
          type: string
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          type: string
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type: boolean
          x-versionadded: v2.33
        verificationCode:
          description: Required if the channel type is Email.
          type: string
          x-versionadded: v2.33
      required:
      - channelType
      - name
      - relatedEntityId
      - relatedEntityType
      type: object
    EntityNotificationChannelResponse:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - DataRobotCustomJob
          - DataRobotGroup
          - DataRobotUser
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
          x-versionadded: v2.33
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          nullable: true
          type: string
          x-versionadded: v2.33
        createdAt:
          description: The date of the notification channel creation.
          format: date-time
          type: string
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          nullable: true
          type: array
          x-versionadded: v2.33
        drEntities:
          description: The IDs of the DataRobot Users, Group or Custom Job associated
            with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
          items:
            $ref: '#/components/schemas/DREntity'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: The id of the notification channel.
          type: string
          x-versionadded: v2.33
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          nullable: true
          type: string
          x-versionadded: v2.33
        lastNotificationAt:
          description: The timestamp of the last notification sent to the channel.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of organization that notification channel belongs to.
          nullable: true
          type: string
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        policyCount:
          description: Count of policies assigned to the channel.
          type: integer
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          nullable: true
          type: boolean
          x-versionadded: v2.33
      required:
      - channelType
      - contentType
      - createdAt
      - customHeaders
      - emailAddress
      - id
      - languageCode
      - lastNotificationAt
      - name
      - orgId
      - payloadUrl
      - policyCount
      - relatedEntityId
      - relatedEntityType
      - secretToken
      - uid
      - updatedAt
      - validateSsl
      type: object
    EntityNotificationChannelsListResponse:
      properties:
        count:
          description: The number of channels returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The notification entity channels.
          items:
            $ref: '#/components/schemas/EntityNotificationChannelResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of channels that satisfy the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    EntityNotificationPoliciesListResponse:
      properties:
        count:
          description: The number of entity policies returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The entity notification policies.
          items:
            $ref: '#/components/schemas/EntityNotificationPolicyResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of entity policies that satisfy the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    EntityNotificationPoliciesTemplatesListResponse:
      properties:
        count:
          description: The number of entity policies templates returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The entity notification policies templates.
          items:
            $ref: '#/components/schemas/EntityNotificationPolicyTemplateResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of entity policies templates that satisfy
            the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    EntityNotificationPolicyCreate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
          x-versionadded: v2.33
        channelScope:
          description: Scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          nullable: true
          type: string
          x-versionadded: v2.33
        eventGroup:
          description: The group of the event that trigger the notification.
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
          x-versionadded: v2.33
        eventType:
          description: The type of the event that triggers the notification.
          enum:
          - secure_config.created
          - secure_config.deleted
          - secure_config.shared
          - comment.created
          - comment.updated
          - credits_system.empty_balance
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.credits_usage
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - decision_flow.shared
          - misc.asset_access_request
          - misc.webhook_connection_test
          - misc.webhook_resend
          - misc.email_verification
          - monitoring.spooler_channel_base
          - monitoring.spooler_channel_red
          - monitoring.spooler_channel_green
          - monitoring.external_model_nan_predictions
          - management.deploymentInfo
          - model_deployments.None
          - model_deployments.deployment_sharing
          - model_deployments.model_replacement
          - prediction_request.None
          - prediction_request.failed
          - model_deployments.model_replacement_lifecycle
          - model_deployments.model_replacement_started
          - model_deployments.model_replacement_succeeded
          - model_deployments.model_replacement_failed
          - model_deployments.model_replacement_validation_warning
          - model_deployments.deployment_creation
          - model_deployments.deployment_deletion
          - model_deployments.service_health_yellow_from_green
          - model_deployments.service_health_yellow_from_red
          - model_deployments.service_health_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.data_drift_yellow_from_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.accuracy_yellow_from_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.green_to_yellow
          - model_deployments.health.fairness_health.red_to_yellow
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.green_to_yellow
          - model_deployments.health.custom_metrics_health.red_to_yellow
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.health.base.green
          - model_deployments.service_health_green
          - model_deployments.data_drift_green
          - model_deployments.accuracy_green
          - model_deployments.health.fairness_health.green
          - model_deployments.health.custom_metrics_health.green
          - model_deployments.retraining_policy_run_started
          - model_deployments.retraining_policy_run_succeeded
          - model_deployments.retraining_policy_run_failed
          - model_deployments.challenger_scoring_finished
          - model_deployments.challenger_scoring_success
          - model_deployments.challenger_scoring_data_warning
          - model_deployments.challenger_scoring_failure
          - model_deployments.challenger_scoring_started
          - model_deployments.challenger_model_validation_warning
          - model_deployments.challenger_model_created
          - model_deployments.challenger_model_deleted
          - model_deployments.actuals_upload_failed
          - model_deployments.actuals_upload_warning
          - model_deployments.training_data_baseline_calculation_started
          - model_deployments.training_data_baseline_calculation_completed
          - model_deployments.training_data_baseline_failed
          - model_deployments.custom_model_deployment_creation_started
          - model_deployments.custom_model_deployment_creation_completed
          - model_deployments.custom_model_deployment_creation_failed
          - model_deployments.deployment_prediction_explanations_preview_job_submitted
          - model_deployments.deployment_prediction_explanations_preview_job_completed
          - model_deployments.deployment_prediction_explanations_preview_job_failed
          - model_deployments.custom_model_deployment_activated
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.prediction_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_warning
          - model_deployments.actuals_processing_rate_limit_reached
          - model_deployments.actuals_processing_rate_limit_warning
          - model_deployments.deployment_monitoring_data_cleared
          - model_deployments.deployment_launch_started
          - model_deployments.deployment_launch_succeeded
          - model_deployments.deployment_launch_failed
          - model_deployments.deployment_shutdown_started
          - model_deployments.deployment_shutdown_succeeded
          - model_deployments.deployment_shutdown_failed
          - model_deployments.endpoint_update_started
          - model_deployments.endpoint_update_succeeded
          - model_deployments.endpoint_update_failed
          - model_deployments.management_agent_service_health_green
          - model_deployments.management_agent_service_health_yellow
          - model_deployments.management_agent_service_health_red
          - model_deployments.management_agent_service_health_unknown
          - model_deployments.predictions_missing_association_id
          - model_deployments.prediction_result_rows_cleand_up
          - model_deployments.batch_deleted
          - model_deployments.batch_creation_limit_reached
          - model_deployments.batch_creation_limit_exceeded
          - model_deployments.batch_not_found
          - model_deployments.predictions_encountered_for_locked_batch
          - model_deployments.predictions_encountered_for_deleted_batch
          - model_deployments.scheduled_report_generated
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.service_health_still_red
          - model_deployments.data_drift_still_red
          - model_deployments.accuracy_still_red
          - model_deployments.health.fairness_health.still_red
          - model_deployments.health.custom_metrics_health.still_red
          - model_deployments.predictions_timeliness_health_still_red
          - model_deployments.actuals_timeliness_health_still_red
          - model_deployments.service_health_still_yellow
          - model_deployments.data_drift_still_yellow
          - model_deployments.accuracy_still_yellow
          - model_deployments.health.fairness_health.still_yellow
          - model_deployments.health.custom_metrics_health.still_yellow
          - model_deployments.deployment_inference_server_creation_started
          - model_deployments.deployment_inference_server_creation_failed
          - model_deployments.deployment_inference_server_creation_completed
          - model_deployments.deployment_inference_server_deletion
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - project.created
          - project.deleted
          - project.shared
          - autopilot.complete
          - autopilot.started
          - autostart.failure
          - perma_delete_project.success
          - perma_delete_project.failure
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - users_delete.started
          - users_delete.completed
          - users_delete.failed
          - application.created
          - application.shared
          - model_version.added
          - model_version.stage_transition_from_registered_to_development
          - model_version.stage_transition_from_registered_to_staging
          - model_version.stage_transition_from_registered_to_production
          - model_version.stage_transition_from_registered_to_archived
          - model_version.stage_transition_from_development_to_registered
          - model_version.stage_transition_from_development_to_staging
          - model_version.stage_transition_from_development_to_production
          - model_version.stage_transition_from_development_to_archived
          - model_version.stage_transition_from_staging_to_registered
          - model_version.stage_transition_from_staging_to_development
          - model_version.stage_transition_from_staging_to_production
          - model_version.stage_transition_from_staging_to_archived
          - model_version.stage_transition_from_production_to_registered
          - model_version.stage_transition_from_production_to_development
          - model_version.stage_transition_from_production_to_staging
          - model_version.stage_transition_from_production_to_archived
          - model_version.stage_transition_from_archived_to_registered
          - model_version.stage_transition_from_archived_to_development
          - model_version.stage_transition_from_archived_to_production
          - model_version.stage_transition_from_archived_to_staging
          - batch_predictions.success
          - batch_predictions.failed
          - batch_predictions.scheduler.auto_disabled
          - change_request.cancelled
          - change_request.created
          - change_request.deployment_approval_requested
          - change_request.resolved
          - change_request.proposed_changes_updated
          - change_request.pending
          - change_request.commenting_review_added
          - change_request.approving_review_added
          - change_request.changes_requesting_review_added
          - prediction_explanations_computation.None
          - prediction_explanations_computation.prediction_explanations_preview_job_submitted
          - prediction_explanations_computation.prediction_explanations_preview_job_completed
          - prediction_explanations_computation.prediction_explanations_preview_job_failed
          - monitoring.rate_limit_enforced
          - notebook_schedule.created
          - notebook_schedule.failure
          - notebook_schedule.completed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification policy.
          maxLength: 100
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of the organization that owns the notification policy.
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
      required:
      - channelId
      - channelScope
      - name
      - relatedEntityId
      - relatedEntityType
      type: object
    EntityNotificationPolicyCreateFromTemplate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        name:
          description: The name of the new notification policy.
          maxLength: 100
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
        templateId:
          description: The id of template.
          type: string
          x-versionadded: v2.33
      required:
      - name
      - relatedEntityId
      - relatedEntityType
      - templateId
      type: object
    EntityNotificationPolicyResponse:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        channel:
          $ref: '#/components/schemas/EntityNotificationChannel'
          description: The information notification channel to be used to send the
            notification.
          nullable: true
          x-versionadded: v2.33
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
          x-versionadded: v2.33
        channelScope:
          description: Scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          nullable: true
          type: string
          x-versionadded: v2.33
        created:
          description: The date when the policy was created.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        eventGroup:
          $ref: '#/components/schemas/EventGroup'
          description: The group of the event that trigger the notification.
          nullable: true
          x-versionadded: v2.33
        eventType:
          $ref: '#/components/schemas/EventType'
          description: The type of the event that triggers the notification.
          nullable: true
          x-versionadded: v2.33
        id:
          description: The id of the policy.
          type: string
          x-versionadded: v2.33
        lastTriggered:
          description: The date when the last notification with the policy was triggered.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of the organization that owns the notification policy.
          nullable: true
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
        templateId:
          description: The id of template.
          nullable: true
          type: string
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the policy.
          type: string
          x-versionadded: v2.33
        updatedAt:
          description: The date when the policy was updated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
      required:
      - active
      - channel
      - channelId
      - channelScope
      - created
      - eventGroup
      - eventType
      - id
      - lastTriggered
      - name
      - orgId
      - relatedEntityId
      - relatedEntityType
      - templateId
      - uid
      - updatedAt
      type: object
    EntityNotificationPolicyTemplateCreate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
          x-versionadded: v2.33
        eventGroup:
          description: The group of the event that trigger the notification.
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
          x-versionadded: v2.33
        eventType:
          description: The type of the event that triggers the notification.
          enum:
          - secure_config.created
          - secure_config.deleted
          - secure_config.shared
          - comment.created
          - comment.updated
          - credits_system.empty_balance
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.credits_usage
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - decision_flow.shared
          - misc.asset_access_request
          - misc.webhook_connection_test
          - misc.webhook_resend
          - misc.email_verification
          - monitoring.spooler_channel_base
          - monitoring.spooler_channel_red
          - monitoring.spooler_channel_green
          - monitoring.external_model_nan_predictions
          - management.deploymentInfo
          - model_deployments.None
          - model_deployments.deployment_sharing
          - model_deployments.model_replacement
          - prediction_request.None
          - prediction_request.failed
          - model_deployments.model_replacement_lifecycle
          - model_deployments.model_replacement_started
          - model_deployments.model_replacement_succeeded
          - model_deployments.model_replacement_failed
          - model_deployments.model_replacement_validation_warning
          - model_deployments.deployment_creation
          - model_deployments.deployment_deletion
          - model_deployments.service_health_yellow_from_green
          - model_deployments.service_health_yellow_from_red
          - model_deployments.service_health_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.data_drift_yellow_from_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.accuracy_yellow_from_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.green_to_yellow
          - model_deployments.health.fairness_health.red_to_yellow
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.green_to_yellow
          - model_deployments.health.custom_metrics_health.red_to_yellow
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.health.base.green
          - model_deployments.service_health_green
          - model_deployments.data_drift_green
          - model_deployments.accuracy_green
          - model_deployments.health.fairness_health.green
          - model_deployments.health.custom_metrics_health.green
          - model_deployments.retraining_policy_run_started
          - model_deployments.retraining_policy_run_succeeded
          - model_deployments.retraining_policy_run_failed
          - model_deployments.challenger_scoring_finished
          - model_deployments.challenger_scoring_success
          - model_deployments.challenger_scoring_data_warning
          - model_deployments.challenger_scoring_failure
          - model_deployments.challenger_scoring_started
          - model_deployments.challenger_model_validation_warning
          - model_deployments.challenger_model_created
          - model_deployments.challenger_model_deleted
          - model_deployments.actuals_upload_failed
          - model_deployments.actuals_upload_warning
          - model_deployments.training_data_baseline_calculation_started
          - model_deployments.training_data_baseline_calculation_completed
          - model_deployments.training_data_baseline_failed
          - model_deployments.custom_model_deployment_creation_started
          - model_deployments.custom_model_deployment_creation_completed
          - model_deployments.custom_model_deployment_creation_failed
          - model_deployments.deployment_prediction_explanations_preview_job_submitted
          - model_deployments.deployment_prediction_explanations_preview_job_completed
          - model_deployments.deployment_prediction_explanations_preview_job_failed
          - model_deployments.custom_model_deployment_activated
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.prediction_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_warning
          - model_deployments.actuals_processing_rate_limit_reached
          - model_deployments.actuals_processing_rate_limit_warning
          - model_deployments.deployment_monitoring_data_cleared
          - model_deployments.deployment_launch_started
          - model_deployments.deployment_launch_succeeded
          - model_deployments.deployment_launch_failed
          - model_deployments.deployment_shutdown_started
          - model_deployments.deployment_shutdown_succeeded
          - model_deployments.deployment_shutdown_failed
          - model_deployments.endpoint_update_started
          - model_deployments.endpoint_update_succeeded
          - model_deployments.endpoint_update_failed
          - model_deployments.management_agent_service_health_green
          - model_deployments.management_agent_service_health_yellow
          - model_deployments.management_agent_service_health_red
          - model_deployments.management_agent_service_health_unknown
          - model_deployments.predictions_missing_association_id
          - model_deployments.prediction_result_rows_cleand_up
          - model_deployments.batch_deleted
          - model_deployments.batch_creation_limit_reached
          - model_deployments.batch_creation_limit_exceeded
          - model_deployments.batch_not_found
          - model_deployments.predictions_encountered_for_locked_batch
          - model_deployments.predictions_encountered_for_deleted_batch
          - model_deployments.scheduled_report_generated
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.service_health_still_red
          - model_deployments.data_drift_still_red
          - model_deployments.accuracy_still_red
          - model_deployments.health.fairness_health.still_red
          - model_deployments.health.custom_metrics_health.still_red
          - model_deployments.predictions_timeliness_health_still_red
          - model_deployments.actuals_timeliness_health_still_red
          - model_deployments.service_health_still_yellow
          - model_deployments.data_drift_still_yellow
          - model_deployments.accuracy_still_yellow
          - model_deployments.health.fairness_health.still_yellow
          - model_deployments.health.custom_metrics_health.still_yellow
          - model_deployments.deployment_inference_server_creation_started
          - model_deployments.deployment_inference_server_creation_failed
          - model_deployments.deployment_inference_server_creation_completed
          - model_deployments.deployment_inference_server_deletion
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - project.created
          - project.deleted
          - project.shared
          - autopilot.complete
          - autopilot.started
          - autostart.failure
          - perma_delete_project.success
          - perma_delete_project.failure
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - users_delete.started
          - users_delete.completed
          - users_delete.failed
          - application.created
          - application.shared
          - model_version.added
          - model_version.stage_transition_from_registered_to_development
          - model_version.stage_transition_from_registered_to_staging
          - model_version.stage_transition_from_registered_to_production
          - model_version.stage_transition_from_registered_to_archived
          - model_version.stage_transition_from_development_to_registered
          - model_version.stage_transition_from_development_to_staging
          - model_version.stage_transition_from_development_to_production
          - model_version.stage_transition_from_development_to_archived
          - model_version.stage_transition_from_staging_to_registered
          - model_version.stage_transition_from_staging_to_development
          - model_version.stage_transition_from_staging_to_production
          - model_version.stage_transition_from_staging_to_archived
          - model_version.stage_transition_from_production_to_registered
          - model_version.stage_transition_from_production_to_development
          - model_version.stage_transition_from_production_to_staging
          - model_version.stage_transition_from_production_to_archived
          - model_version.stage_transition_from_archived_to_registered
          - model_version.stage_transition_from_archived_to_development
          - model_version.stage_transition_from_archived_to_production
          - model_version.stage_transition_from_archived_to_staging
          - batch_predictions.success
          - batch_predictions.failed
          - batch_predictions.scheduler.auto_disabled
          - change_request.cancelled
          - change_request.created
          - change_request.deployment_approval_requested
          - change_request.resolved
          - change_request.proposed_changes_updated
          - change_request.pending
          - change_request.commenting_review_added
          - change_request.approving_review_added
          - change_request.changes_requesting_review_added
          - prediction_explanations_computation.None
          - prediction_explanations_computation.prediction_explanations_preview_job_submitted
          - prediction_explanations_computation.prediction_explanations_preview_job_completed
          - prediction_explanations_computation.prediction_explanations_preview_job_failed
          - monitoring.rate_limit_enforced
          - notebook_schedule.created
          - notebook_schedule.failure
          - notebook_schedule.completed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification policy.
          maxLength: 100
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of the organization that owns the notification policy.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
      required:
      - channelId
      - name
      - relatedEntityType
      type: object
    EntityNotificationPolicyTemplateRelatedPoliciesListResponse:
      properties:
        count:
          description: The number of entity policies returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The entity notification policies.
          items:
            $ref: '#/components/schemas/EntityNotificationPolicyTemplateRelatedPolicyResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of entity policies that satisfy the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    EntityNotificationPolicyTemplateRelatedPolicyResponse:
      properties:
        id:
          description: The id of the policy.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityName:
          description: The name of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      - relatedEntityId
      - relatedEntityName
      - relatedEntityType
      type: object
    EntityNotificationPolicyTemplateResponse:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        channel:
          $ref: '#/components/schemas/EntityNotificationChannel'
          description: The information notification channel template to be used to
            send the notification.
          nullable: true
          x-versionadded: v2.33
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
          x-versionadded: v2.33
        channelScope:
          description: Scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          type: string
          x-versionadded: v2.33
        created:
          description: The date when the policy was created.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/CreatedByResponse'
          description: User that created template.
          nullable: true
          x-versionadded: v2.33
        eventGroup:
          $ref: '#/components/schemas/EventGroup'
          description: The group of the event that trigger the notification.
          nullable: true
          x-versionadded: v2.33
        eventType:
          $ref: '#/components/schemas/EventType'
          description: The type of the event that triggers the notification.
          nullable: true
          x-versionadded: v2.33
        id:
          description: The id of the policy.
          type: string
          x-versionadded: v2.33
        lastTriggered:
          description: The date when the last notification with the policy was triggered.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of the organization that owns the notification policy.
          nullable: true
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
        relatedPoliciesCount:
          description: The total number of entity policies that are using this template.
          type: integer
          x-versionadded: v2.33
        role:
          description: User role on entity.
          nullable: true
          type: string
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the policy.
          type: string
          x-versionadded: v2.33
        updatedAt:
          description: The date when the policy was updated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
      required:
      - active
      - channel
      - channelId
      - created
      - createdBy
      - eventGroup
      - eventType
      - id
      - lastTriggered
      - name
      - orgId
      - relatedEntityType
      - relatedPoliciesCount
      - role
      - uid
      - updatedAt
      type: object
    EntityNotificationPolicyTemplateUpdate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
          x-versionadded: v2.33
        eventGroup:
          description: The group of the event that trigger the notification.
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
          x-versionadded: v2.33
        eventType:
          description: The type of the event that triggers the notification.
          enum:
          - secure_config.created
          - secure_config.deleted
          - secure_config.shared
          - comment.created
          - comment.updated
          - credits_system.empty_balance
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.credits_usage
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - decision_flow.shared
          - misc.asset_access_request
          - misc.webhook_connection_test
          - misc.webhook_resend
          - misc.email_verification
          - monitoring.spooler_channel_base
          - monitoring.spooler_channel_red
          - monitoring.spooler_channel_green
          - monitoring.external_model_nan_predictions
          - management.deploymentInfo
          - model_deployments.None
          - model_deployments.deployment_sharing
          - model_deployments.model_replacement
          - prediction_request.None
          - prediction_request.failed
          - model_deployments.model_replacement_lifecycle
          - model_deployments.model_replacement_started
          - model_deployments.model_replacement_succeeded
          - model_deployments.model_replacement_failed
          - model_deployments.model_replacement_validation_warning
          - model_deployments.deployment_creation
          - model_deployments.deployment_deletion
          - model_deployments.service_health_yellow_from_green
          - model_deployments.service_health_yellow_from_red
          - model_deployments.service_health_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.data_drift_yellow_from_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.accuracy_yellow_from_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.green_to_yellow
          - model_deployments.health.fairness_health.red_to_yellow
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.green_to_yellow
          - model_deployments.health.custom_metrics_health.red_to_yellow
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.health.base.green
          - model_deployments.service_health_green
          - model_deployments.data_drift_green
          - model_deployments.accuracy_green
          - model_deployments.health.fairness_health.green
          - model_deployments.health.custom_metrics_health.green
          - model_deployments.retraining_policy_run_started
          - model_deployments.retraining_policy_run_succeeded
          - model_deployments.retraining_policy_run_failed
          - model_deployments.challenger_scoring_finished
          - model_deployments.challenger_scoring_success
          - model_deployments.challenger_scoring_data_warning
          - model_deployments.challenger_scoring_failure
          - model_deployments.challenger_scoring_started
          - model_deployments.challenger_model_validation_warning
          - model_deployments.challenger_model_created
          - model_deployments.challenger_model_deleted
          - model_deployments.actuals_upload_failed
          - model_deployments.actuals_upload_warning
          - model_deployments.training_data_baseline_calculation_started
          - model_deployments.training_data_baseline_calculation_completed
          - model_deployments.training_data_baseline_failed
          - model_deployments.custom_model_deployment_creation_started
          - model_deployments.custom_model_deployment_creation_completed
          - model_deployments.custom_model_deployment_creation_failed
          - model_deployments.deployment_prediction_explanations_preview_job_submitted
          - model_deployments.deployment_prediction_explanations_preview_job_completed
          - model_deployments.deployment_prediction_explanations_preview_job_failed
          - model_deployments.custom_model_deployment_activated
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.prediction_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_warning
          - model_deployments.actuals_processing_rate_limit_reached
          - model_deployments.actuals_processing_rate_limit_warning
          - model_deployments.deployment_monitoring_data_cleared
          - model_deployments.deployment_launch_started
          - model_deployments.deployment_launch_succeeded
          - model_deployments.deployment_launch_failed
          - model_deployments.deployment_shutdown_started
          - model_deployments.deployment_shutdown_succeeded
          - model_deployments.deployment_shutdown_failed
          - model_deployments.endpoint_update_started
          - model_deployments.endpoint_update_succeeded
          - model_deployments.endpoint_update_failed
          - model_deployments.management_agent_service_health_green
          - model_deployments.management_agent_service_health_yellow
          - model_deployments.management_agent_service_health_red
          - model_deployments.management_agent_service_health_unknown
          - model_deployments.predictions_missing_association_id
          - model_deployments.prediction_result_rows_cleand_up
          - model_deployments.batch_deleted
          - model_deployments.batch_creation_limit_reached
          - model_deployments.batch_creation_limit_exceeded
          - model_deployments.batch_not_found
          - model_deployments.predictions_encountered_for_locked_batch
          - model_deployments.predictions_encountered_for_deleted_batch
          - model_deployments.scheduled_report_generated
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.service_health_still_red
          - model_deployments.data_drift_still_red
          - model_deployments.accuracy_still_red
          - model_deployments.health.fairness_health.still_red
          - model_deployments.health.custom_metrics_health.still_red
          - model_deployments.predictions_timeliness_health_still_red
          - model_deployments.actuals_timeliness_health_still_red
          - model_deployments.service_health_still_yellow
          - model_deployments.data_drift_still_yellow
          - model_deployments.accuracy_still_yellow
          - model_deployments.health.fairness_health.still_yellow
          - model_deployments.health.custom_metrics_health.still_yellow
          - model_deployments.deployment_inference_server_creation_started
          - model_deployments.deployment_inference_server_creation_failed
          - model_deployments.deployment_inference_server_creation_completed
          - model_deployments.deployment_inference_server_deletion
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - project.created
          - project.deleted
          - project.shared
          - autopilot.complete
          - autopilot.started
          - autostart.failure
          - perma_delete_project.success
          - perma_delete_project.failure
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - users_delete.started
          - users_delete.completed
          - users_delete.failed
          - application.created
          - application.shared
          - model_version.added
          - model_version.stage_transition_from_registered_to_development
          - model_version.stage_transition_from_registered_to_staging
          - model_version.stage_transition_from_registered_to_production
          - model_version.stage_transition_from_registered_to_archived
          - model_version.stage_transition_from_development_to_registered
          - model_version.stage_transition_from_development_to_staging
          - model_version.stage_transition_from_development_to_production
          - model_version.stage_transition_from_development_to_archived
          - model_version.stage_transition_from_staging_to_registered
          - model_version.stage_transition_from_staging_to_development
          - model_version.stage_transition_from_staging_to_production
          - model_version.stage_transition_from_staging_to_archived
          - model_version.stage_transition_from_production_to_registered
          - model_version.stage_transition_from_production_to_development
          - model_version.stage_transition_from_production_to_staging
          - model_version.stage_transition_from_production_to_archived
          - model_version.stage_transition_from_archived_to_registered
          - model_version.stage_transition_from_archived_to_development
          - model_version.stage_transition_from_archived_to_production
          - model_version.stage_transition_from_archived_to_staging
          - batch_predictions.success
          - batch_predictions.failed
          - batch_predictions.scheduler.auto_disabled
          - change_request.cancelled
          - change_request.created
          - change_request.deployment_approval_requested
          - change_request.resolved
          - change_request.proposed_changes_updated
          - change_request.pending
          - change_request.commenting_review_added
          - change_request.approving_review_added
          - change_request.changes_requesting_review_added
          - prediction_explanations_computation.None
          - prediction_explanations_computation.prediction_explanations_preview_job_submitted
          - prediction_explanations_computation.prediction_explanations_preview_job_completed
          - prediction_explanations_computation.prediction_explanations_preview_job_failed
          - monitoring.rate_limit_enforced
          - notebook_schedule.created
          - notebook_schedule.failure
          - notebook_schedule.completed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          maxLength: 100
          type: string
          x-versionadded: v2.33
      type: object
    EntityNotificationPolicyUpdate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
          x-versionadded: v2.33
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
          x-versionadded: v2.33
        channelScope:
          description: Scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          type: string
          x-versionadded: v2.33
        eventGroup:
          description: The group of the event that trigger the notification.
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
          x-versionadded: v2.33
        eventType:
          description: The type of the event that triggers the notification.
          enum:
          - secure_config.created
          - secure_config.deleted
          - secure_config.shared
          - comment.created
          - comment.updated
          - credits_system.empty_balance
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.credits_usage
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - decision_flow.shared
          - misc.asset_access_request
          - misc.webhook_connection_test
          - misc.webhook_resend
          - misc.email_verification
          - monitoring.spooler_channel_base
          - monitoring.spooler_channel_red
          - monitoring.spooler_channel_green
          - monitoring.external_model_nan_predictions
          - management.deploymentInfo
          - model_deployments.None
          - model_deployments.deployment_sharing
          - model_deployments.model_replacement
          - prediction_request.None
          - prediction_request.failed
          - model_deployments.model_replacement_lifecycle
          - model_deployments.model_replacement_started
          - model_deployments.model_replacement_succeeded
          - model_deployments.model_replacement_failed
          - model_deployments.model_replacement_validation_warning
          - model_deployments.deployment_creation
          - model_deployments.deployment_deletion
          - model_deployments.service_health_yellow_from_green
          - model_deployments.service_health_yellow_from_red
          - model_deployments.service_health_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.data_drift_yellow_from_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.accuracy_yellow_from_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.green_to_yellow
          - model_deployments.health.fairness_health.red_to_yellow
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.green_to_yellow
          - model_deployments.health.custom_metrics_health.red_to_yellow
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.health.base.green
          - model_deployments.service_health_green
          - model_deployments.data_drift_green
          - model_deployments.accuracy_green
          - model_deployments.health.fairness_health.green
          - model_deployments.health.custom_metrics_health.green
          - model_deployments.retraining_policy_run_started
          - model_deployments.retraining_policy_run_succeeded
          - model_deployments.retraining_policy_run_failed
          - model_deployments.challenger_scoring_finished
          - model_deployments.challenger_scoring_success
          - model_deployments.challenger_scoring_data_warning
          - model_deployments.challenger_scoring_failure
          - model_deployments.challenger_scoring_started
          - model_deployments.challenger_model_validation_warning
          - model_deployments.challenger_model_created
          - model_deployments.challenger_model_deleted
          - model_deployments.actuals_upload_failed
          - model_deployments.actuals_upload_warning
          - model_deployments.training_data_baseline_calculation_started
          - model_deployments.training_data_baseline_calculation_completed
          - model_deployments.training_data_baseline_failed
          - model_deployments.custom_model_deployment_creation_started
          - model_deployments.custom_model_deployment_creation_completed
          - model_deployments.custom_model_deployment_creation_failed
          - model_deployments.deployment_prediction_explanations_preview_job_submitted
          - model_deployments.deployment_prediction_explanations_preview_job_completed
          - model_deployments.deployment_prediction_explanations_preview_job_failed
          - model_deployments.custom_model_deployment_activated
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.prediction_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_warning
          - model_deployments.actuals_processing_rate_limit_reached
          - model_deployments.actuals_processing_rate_limit_warning
          - model_deployments.deployment_monitoring_data_cleared
          - model_deployments.deployment_launch_started
          - model_deployments.deployment_launch_succeeded
          - model_deployments.deployment_launch_failed
          - model_deployments.deployment_shutdown_started
          - model_deployments.deployment_shutdown_succeeded
          - model_deployments.deployment_shutdown_failed
          - model_deployments.endpoint_update_started
          - model_deployments.endpoint_update_succeeded
          - model_deployments.endpoint_update_failed
          - model_deployments.management_agent_service_health_green
          - model_deployments.management_agent_service_health_yellow
          - model_deployments.management_agent_service_health_red
          - model_deployments.management_agent_service_health_unknown
          - model_deployments.predictions_missing_association_id
          - model_deployments.prediction_result_rows_cleand_up
          - model_deployments.batch_deleted
          - model_deployments.batch_creation_limit_reached
          - model_deployments.batch_creation_limit_exceeded
          - model_deployments.batch_not_found
          - model_deployments.predictions_encountered_for_locked_batch
          - model_deployments.predictions_encountered_for_deleted_batch
          - model_deployments.scheduled_report_generated
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.service_health_still_red
          - model_deployments.data_drift_still_red
          - model_deployments.accuracy_still_red
          - model_deployments.health.fairness_health.still_red
          - model_deployments.health.custom_metrics_health.still_red
          - model_deployments.predictions_timeliness_health_still_red
          - model_deployments.actuals_timeliness_health_still_red
          - model_deployments.service_health_still_yellow
          - model_deployments.data_drift_still_yellow
          - model_deployments.accuracy_still_yellow
          - model_deployments.health.fairness_health.still_yellow
          - model_deployments.health.custom_metrics_health.still_yellow
          - model_deployments.deployment_inference_server_creation_started
          - model_deployments.deployment_inference_server_creation_failed
          - model_deployments.deployment_inference_server_creation_completed
          - model_deployments.deployment_inference_server_deletion
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - project.created
          - project.deleted
          - project.shared
          - autopilot.complete
          - autopilot.started
          - autostart.failure
          - perma_delete_project.success
          - perma_delete_project.failure
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - users_delete.started
          - users_delete.completed
          - users_delete.failed
          - application.created
          - application.shared
          - model_version.added
          - model_version.stage_transition_from_registered_to_development
          - model_version.stage_transition_from_registered_to_staging
          - model_version.stage_transition_from_registered_to_production
          - model_version.stage_transition_from_registered_to_archived
          - model_version.stage_transition_from_development_to_registered
          - model_version.stage_transition_from_development_to_staging
          - model_version.stage_transition_from_development_to_production
          - model_version.stage_transition_from_development_to_archived
          - model_version.stage_transition_from_staging_to_registered
          - model_version.stage_transition_from_staging_to_development
          - model_version.stage_transition_from_staging_to_production
          - model_version.stage_transition_from_staging_to_archived
          - model_version.stage_transition_from_production_to_registered
          - model_version.stage_transition_from_production_to_development
          - model_version.stage_transition_from_production_to_staging
          - model_version.stage_transition_from_production_to_archived
          - model_version.stage_transition_from_archived_to_registered
          - model_version.stage_transition_from_archived_to_development
          - model_version.stage_transition_from_archived_to_production
          - model_version.stage_transition_from_archived_to_staging
          - batch_predictions.success
          - batch_predictions.failed
          - batch_predictions.scheduler.auto_disabled
          - change_request.cancelled
          - change_request.created
          - change_request.deployment_approval_requested
          - change_request.resolved
          - change_request.proposed_changes_updated
          - change_request.pending
          - change_request.commenting_review_added
          - change_request.approving_review_added
          - change_request.changes_requesting_review_added
          - prediction_explanations_computation.None
          - prediction_explanations_computation.prediction_explanations_preview_job_submitted
          - prediction_explanations_computation.prediction_explanations_preview_job_completed
          - prediction_explanations_computation.prediction_explanations_preview_job_failed
          - monitoring.rate_limit_enforced
          - notebook_schedule.created
          - notebook_schedule.failure
          - notebook_schedule.completed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          maxLength: 100
          type: string
          x-versionadded: v2.33
      type: object
    EureqaDistributionDetailResponse:
      properties:
        bins:
          description: The distribution plot data.
          items:
            $ref: '#/components/schemas/ClassificationBinDataResponse'
          type: array
        complexity:
          description: The complexity score for this solution. Complexity score is
            a function of the mathematical operators used in the current solution.
            The complexity calculation can be tuned via model hyperparameters.
          type: integer
        error:
          description: The error for the current solution, as computed by eureqa using
            the `errorMetric` error metric. None if Eureqa model refitted existing
            solutions.
          nullable: true
          type: number
        errorMetric:
          description: The Eureqa error metric identifier used to compute error metrics
            for this search. Note that Eureqa error metrics do not correspond 1:1
            with DataRobot error metrics - the available metrics are not the same,
            and even equivalent metrics may be computed slightly differently.
          type: string
        eureqaSolutionId:
          description: The ID of the solution.
          type: string
        expression:
          description: The eureqa "solution string". This is a mathematical expression;
            human-readable but with strict syntax specifications defined by Eureqa.
          type: string
        expressionAnnotated:
          description: The `expression`, rendered with additional tags to assist in
            automatic parsing.
          type: string
        threshold:
          description: Classifier threshold selected by the backend, used to determine
            which model values are binned as positive and which are binned as negative.
            Must have a value between the `binStart` of the first bin and `binEnd`
            of the last bin.
          type: number
      required:
      - bins
      - complexity
      - error
      - errorMetric
      - eureqaSolutionId
      - expression
      - expressionAnnotated
      - threshold
      type: object
    EureqaLeaderboardEntryPayload:
      properties:
        parentModelId:
          description: The ID of the model to clone from. If omitted, will automatically
            search for and find the first leaderboard model created by the blueprint
            run that also created the solution associated with `solutionId`.
          type: string
        solutionId:
          description: the ID of the solution to be cloned.
          type: string
      required:
      - solutionId
      type: object
    EureqaModelDetailResponse:
      properties:
        complexity:
          description: The complexity score for this solution. Complexity score is
            a function of the mathematical operators used in the current solution.
            The complexity calculation can be tuned via model hyperparameters.
          type: integer
        error:
          description: The error for the current solution, as computed by eureqa using
            the `errorMetric` error metric. None if Eureqa model refitted existing
            solutions.
          nullable: true
          type: number
        errorMetric:
          description: The Eureqa error metric identifier used to compute error metrics
            for this search. Note that Eureqa error metrics do not correspond 1:1
            with DataRobot error metrics - the available metrics are not the same,
            and even equivalent metrics may be computed slightly differently.
          type: string
        eureqaSolutionId:
          description: The ID of the solution.
          type: string
        expression:
          description: The eureqa "solution string". This is a mathematical expression;
            human-readable but with strict syntax specifications defined by Eureqa.
          type: string
        expressionAnnotated:
          description: The `expression`, rendered with additional tags to assist in
            automatic parsing.
          type: string
        plotData:
          description: The plot data.
          items:
            $ref: '#/components/schemas/PlotDataResponse'
          type: array
      required:
      - complexity
      - error
      - errorMetric
      - eureqaSolutionId
      - expression
      - expressionAnnotated
      - plotData
      type: object
    EventGroup:
      properties:
        events:
          description: The events included in this group.
          items:
            $ref: '#/components/schemas/EventType'
          type: array
        id:
          description: The id of the event group.
          type: string
        label:
          description: The display name of the event group.
          type: string
      required:
      - events
      - id
      - label
      type: object
    EventGroupResponse:
      properties:
        events:
          description: Event types belonging to the group
          items:
            type: string
          type: array
        id:
          description: Group ID
          type: string
        label:
          description: Group name for display
          type: string
        requireMaxFrequency:
          description: Indicates if a group requires max frequency setting.
          type: boolean
      required:
      - events
      - id
      - label
      - requireMaxFrequency
      type: object
    EventResponse:
      properties:
        id:
          description: Event type as an ID
          type: string
        label:
          description: Event type for display
          type: string
        requireMaxFrequency:
          description: Indicates if an event requires max frequency setting.
          type: boolean
      required:
      - id
      - label
      - requireMaxFrequency
      type: object
    EventType:
      properties:
        id:
          description: The id of the event type.
          type: string
        label:
          description: The display name of the event type.
          type: string
      required:
      - id
      - label
      type: object
    ExecutionEnvironmentShortResponse:
      properties:
        id:
          description: The ID of the execution environment.
          type: string
        name:
          description: User-friendly name of the execution environment.
          type: string
      required:
      - id
      - name
      type: object
    ExecutionEnvironmentVersionShortResponse:
      properties:
        id:
          description: The ID of the execution environment version.
          type: string
        label:
          description: User-friendly name of the execution environment version.
          type: string
      required:
      - id
      - label
      type: object
    ExperimentContainerApplicationResponse:
      properties:
        applicationId:
          description: The application id of the application.
          type: string
        applicationTemplateType:
          description: The type of the application.
          nullable: true
          type: string
        createdAt:
          description: The timestamp generated at application creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the application
        description:
          description: The description of the application.
          nullable: true
          type: string
        lastActivity:
          $ref: '#/components/schemas/ExperimentContainerLastActivity'
          description: Last activity details
        name:
          description: The name of the application.
          type: string
        projectId:
          description: The ID of the associated project
          nullable: true
          type: string
        source:
          description: The source used to create the application.
          nullable: true
          type: string
        updatedAt:
          description: The timestamp generated at application modification.
          format: date-time
          type: string
      required:
      - applicationId
      - applicationTemplateType
      - createdAt
      - createdBy
      - description
      - lastActivity
      - name
      - projectId
      - source
      - updatedAt
      type: object
    ExperimentContainerFilterMetadataMetricsObjectResponse:
      properties:
        binary:
          description: Binary metrics associated with the models
          items:
            description: Binary metric names
            enum:
            - AUC
            - Weighted AUC
            - Area Under PR Curve
            - Weighted Area Under PR Curve
            - Kolmogorov-Smirnov
            - Weighted Kolmogorov-Smirnov
            - FVE Binomial
            - Weighted FVE Binomial
            - Gini Norm
            - Weighted Gini Norm
            - LogLoss
            - Weighted LogLoss
            - Max MCC
            - Weighted Max MCC
            - Rate@Top5%
            - Weighted Rate@Top5%
            - Rate@Top10%
            - Weighted Rate@Top10%
            - Rate@TopTenth%
            - RMSE
            - Weighted RMSE
            type: string
          type: array
        regression:
          description: Regression metrics associated with the models
          items:
            description: Regression metric names
            enum:
            - FVE Poisson
            - Weighted FVE Poisson
            - FVE Gamma
            - Weighted FVE Gamma
            - FVE Tweedie
            - Weighted FVE Tweedie
            - Gamma Deviance
            - Weighted Gamma Deviance
            - Gini Norm
            - Weighted Gini Norm
            - MAE
            - Weighted MAE
            - MAPE
            - Weighted MAPE
            - SMAPE
            - Weighted SMAPE
            - Poisson Deviance
            - Weighted Poisson Deviance
            - RMSLE
            - RMSE
            - Weighted RMSLE
            - Weighted RMSE
            - R Squared
            - Weighted R Squared
            - Tweedie Deviance
            - Weighted Tweedie Deviance
            type: string
          type: array
      type: object
    ExperimentContainerFilterMetadataModelFamiliesObjectResponse:
      properties:
        fullName:
          description: Full name of the model family
          type: string
        key:
          description: Abbreviated form of model family name
          enum:
          - AB
          - AD
          - BLENDER
          - CAL
          - CLUSTER
          - COUNT_DICT
          - CUSTOM
          - DOCUMENT
          - DT
          - DUMMY
          - EP
          - EQ
          - EQ_TS
          - FM
          - GAM
          - GBM
          - GLM
          - GLMNET
          - IMAGE
          - KNN
          - NB
          - NN
          - OTHER
          - RF
          - RI
          - SEGMENTED
          - SVM
          - TEXT
          - TS
          - TS_NN
          - TTS
          - VW
          type: string
      required:
      - fullName
      - key
      type: object
    ExperimentContainerFilterMetadataRetrieveResponse:
      properties:
        metrics:
          $ref: '#/components/schemas/ExperimentContainerFilterMetadataMetricsObjectResponse'
          description: Model performance evaluation metrics (shorthand abbreviations)
        modelFamilies:
          description: Model families associated with the models
          items:
            $ref: '#/components/schemas/ExperimentContainerFilterMetadataModelFamiliesObjectResponse'
          maxItems: 32
          type: array
        samplePcts:
          description: Model training sample sizes (in percentage)
          items:
            exclusiveMinimum: true
            maximum: 100
            minimum: 0
            type: number
          maxItems: 7
          type: array
      required:
      - metrics
      - modelFamilies
      - samplePcts
      type: object
    ExperimentContainerLastActivity:
      properties:
        timestamp:
          description: Time when this activity occurred.
          format: date-time
          type: string
        type:
          description: The type of activity. Can be "Added" or "Modified"
          type: string
      required:
      - timestamp
      - type
      type: object
    ExperimentContainerModelsForComparisonModelResponse:
      properties:
        autopilotDataSelectionMethod:
          description: The Data Selection method of the datetime-partitioned model.
            `null` if model is not datetime-partitioned.
          enum:
          - duration
          - rowCount
          nullable: true
          type: string
        createdAt:
          description: Timestamp generated at model's project creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the model
        datasetName:
          description: Name of the dataset used to build the project associated with
            the model
          type: string
        hasCodegen:
          description: Whether the model can be converted to scorable java code
          type: boolean
        hasHoldout:
          description: Whether the model has holdout.
          type: boolean
        isDatetimePartitioned:
          description: Indicates whether the model is a datetime-partitioned model.
          type: boolean
        isScoringAvailableForModelsTrainedIntoValidationHoldout:
          description: Indicates whether validation scores are available. A result
            of 'N/A' in the UI indicates that a model was trained into validation
            or holdout and also either does not have stacked predictions or uses extended
            multiclass.
          type: boolean
        isStarred:
          description: Whether the model has been starred
          type: boolean
        isTrainedIntoHoldout:
          description: Whether the model used holdout data for training.
          type: boolean
        isTrainedIntoValidation:
          description: Whether the model used validation data for training.
          type: boolean
        metric:
          description: Model performance information by the specified filtered evaluation
            metric
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
        modelFamily:
          description: Model family associated with the model
          enum:
          - AB
          - AD
          - BLENDER
          - CAL
          - CLUSTER
          - COUNT_DICT
          - CUSTOM
          - DOCUMENT
          - DT
          - DUMMY
          - EP
          - EQ
          - EQ_TS
          - FM
          - GAM
          - GBM
          - GLM
          - GLMNET
          - IMAGE
          - KNN
          - NB
          - NN
          - OTHER
          - RF
          - RI
          - SEGMENTED
          - SVM
          - TEXT
          - TS
          - TS_NN
          - TTS
          - VW
          type: string
        modelId:
          description: ID of the model
          type: string
        name:
          description: Name of the model
          type: string
        projectId:
          description: ID of the project associated with the model
          type: string
        projectName:
          description: Name of the project associated with the model
          type: string
        samplePct:
          description: Percentage of the dataset to use with the model
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        targetName:
          description: Name of modeling target
          type: string
        targetType:
          description: Type of modeling target
          enum:
          - Binary
          - Regression
          type: string
      required:
      - autopilotDataSelectionMethod
      - createdAt
      - createdBy
      - datasetName
      - hasCodegen
      - hasHoldout
      - isDatetimePartitioned
      - isScoringAvailableForModelsTrainedIntoValidationHoldout
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - metric
      - modelFamily
      - modelId
      - name
      - projectId
      - projectName
      - samplePct
      - targetName
      - targetType
      type: object
    ExperimentContainerNotebookResponse:
      properties:
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the notebook
        createdAt:
          description: The timestamp generated at notebook creation.
          format: date-time
          type: string
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        entityId:
          description: The primary id of the entity (same as ID of the notebook).
          type: string
        entityType:
          description: The type of entity provided by the entity id.
          enum:
          - notebook
          type: string
        experimentContainerId:
          description: '[DEPRECATED - replaced with use_case_id] The ID of the Use
            Case.'
          type: string
          x-versiondeprecated: v2.32
        id:
          description: The ID of the notebook.
          type: string
        isDeleted:
          description: Soft deletion flag for notebooks
          type: boolean
        referenceId:
          description: Original ID from DB
          type: string
        tenantId:
          description: The id of the tenant the notebook belongs to.
          nullable: true
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
        useCaseId:
          description: The ID of the Use Case.
          type: string
        useCaseName:
          description: Use Case name
          type: string
      required:
      - created
      - createdAt
      - entityId
      - entityType
      - experimentContainerId
      - id
      - isDeleted
      - referenceId
      - tenantId
      - useCaseId
      type: object
    ExperimentContainerPlaygroundResponse:
      properties:
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the playground
        createdAt:
          description: The timestamp generated at playground creation.
          format: date-time
          type: string
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        entityId:
          description: The primary id of the entity (same as ID of the playground).
          type: string
        entityType:
          description: The type of entity provided by the entity id.
          enum:
          - playground
          type: string
        id:
          description: The ID of the playground.
          type: string
        isDeleted:
          description: Soft deletion flag for playgrounds
          type: boolean
        referenceId:
          description: Original ID from DB
          type: string
        tenantId:
          description: The id of the tenant the playground belongs to.
          nullable: true
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
      required:
      - created
      - createdAt
      - entityId
      - entityType
      - id
      - isDeleted
      - referenceId
      - tenantId
      type: object
    ExperimentContainerReferenceDatasetMetadata:
      properties:
        dataSourceType:
          description: The type of the data source used to create the dataset if relevant.
          nullable: true
          type: string
        datasetSourceType:
          description: The source type of the dataset
          nullable: true
          type: string
        isSnapshot:
          description: Whether the dataset is an immutable snapshot of data which
            has previously been retrieved and saved to DataRobot.
          type: boolean
        isWranglingEligible:
          description: Whether the source of the dataset can support wrangling.
          type: boolean
        latestRecipeId:
          description: The latest recipe id linked to the dataset.
          nullable: true
          type: string
      required:
      - dataSourceType
      - datasetSourceType
      - isSnapshot
      - isWranglingEligible
      - latestRecipeId
      type: object
    ExperimentContainerReferenceDatasetResponse:
      properties:
        createdAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the record
        lastActivity:
          $ref: '#/components/schemas/ExperimentContainerLastActivity'
          description: Last activity details
      required:
      - createdAt
      - lastActivity
      type: object
    ExperimentContainerReferencePlaygroundMetadata:
      properties:
        description:
          description: Description of the playground
          type: string
      required:
      - description
      type: object
    ExperimentContainerReferenceProjectMetadata:
      properties:
        isDraft:
          description: Indicates whether the experiment configuration has been used
            for modeling and is therefore locked (False) or whether the setup has
            not been applied , and as a draft, can still be modified and used in training
            (True).
          type: boolean
        isErrored:
          description: Indicates whether the experiment failed.
          type: boolean
        isWorkbenchEligible:
          description: Indicates whether the experiment is Workbench-compatible.
          type: boolean
        statusErrorMessage:
          description: Experiment failure explanation.
          type: string
      required:
      - isDraft
      - isErrored
      - isWorkbenchEligible
      - statusErrorMessage
      type: object
    ExperimentContainerReferenceRecipeMetadata:
      properties:
        dataType:
          description: The type of the recipe (wrangling or feature discovery)
          enum:
          - static
          - Static
          - STATIC
          - snapshot
          - Snapshot
          - SNAPSHOT
          - dynamic
          - Dynamic
          - DYNAMIC
          - wranglingRecipe
          - WranglingRecipe
          - WRANGLING_RECIPE
          - featureDiscoveryRecipe
          - FeatureDiscoveryRecipe
          - FEATURE_DISCOVERY_RECIPE
          nullable: true
          type: string
      required:
      - dataType
      type: object
    ExperimentContainerReferenceRetrieve:
      properties:
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        entityId:
          description: The primary id of the entity.
          type: string
        entityType:
          description: The type of entity provided by the entity id.
          type: string
        id:
          description: The ID of the experiment container reference.
          type: string
        lastActivity:
          $ref: '#/components/schemas/ExperimentContainerLastActivity'
          description: Last activity details.
        metadata:
          description: Reference metadata for the experiment container
          oneOf:
          - $ref: '#/components/schemas/ExperimentContainerReferenceProjectMetadata'
          - $ref: '#/components/schemas/ExperimentContainerReferenceDatasetMetadata'
          - $ref: '#/components/schemas/ExperimentContainerReferenceRecipeMetadata'
          - $ref: '#/components/schemas/ExperimentContainerReferencePlaygroundMetadata'
        name:
          description: The name of the experiment container reference.
          type: string
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who was the last one to update the container reference
        updatedAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
        useCaseId:
          description: The ID linking the Use Case with the entity type.
          type: string
      required:
      - entityId
      - entityType
      - id
      - lastActivity
      - name
      - updated
      - updatedAt
      - useCaseId
      type: object
    ExperimentContainerSharedRolesUpdate:
      properties:
        operation:
          description: The name of the action being taken. Only 'updateRoles' is supported.
          enum:
          - updateRoles
          type: string
        roles:
          description: A list of sharing role objects
          items:
            oneOf:
            - $ref: '#/components/schemas/ExperimentContainerSharingRoleUpdateDataWithName'
            - $ref: '#/components/schemas/ExperimentContainerSharingRoleUpdateDataWithId'
          minItems: 1
          type: array
      required:
      - operation
      - roles
      type: object
    ExperimentContainerSharingRoleUpdateDataWithId:
      properties:
        id:
          description: The ID of the recipient
          type: string
        role:
          description: The assigned role
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type
          enum:
          - user
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    ExperimentContainerSharingRoleUpdateDataWithName:
      properties:
        name:
          description: Name of the user to update the access role for.
          type: string
        role:
          description: The assigned role
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type
          enum:
          - user
          - organization
          type: string
      required:
      - name
      - role
      - shareRecipientType
      type: object
    ExperimentContainerUserResponse:
      properties:
        email:
          description: The email address of the user.
          nullable: true
          type: string
        fullName:
          description: The full name of the user.
          nullable: true
          type: string
        id:
          description: The id of the user.
          type: string
        userhash:
          description: User's gravatar hash.
          nullable: true
          type: string
        username:
          description: The username of the user.
          nullable: true
          type: string
      required:
      - email
      - id
      type: object
    ExperimentContainerVectorDatabaseResponse:
      properties:
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the vector database
        createdAt:
          description: The timestamp generated at vector database creation.
          format: date-time
          type: string
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        entityId:
          description: The primary id of the entity (same as ID of the vector database).
          type: string
        entityType:
          description: The type of entity provided by the entity id.
          enum:
          - vector_database
          type: string
        id:
          description: The ID of the vector database.
          type: string
        isDeleted:
          description: Soft deletion flag for vector databases
          type: boolean
        referenceId:
          description: Original ID from DB
          type: string
        tenantId:
          description: The id of the tenant the vector database belongs to.
          nullable: true
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
      required:
      - created
      - createdAt
      - entityId
      - entityType
      - id
      - isDeleted
      - referenceId
      - tenantId
      type: object
    ExportCreatePayload:
      properties:
        augmentationType:
          default: NO_AUGMENTATION
          description: Indicates if prediction data is augmented with actuals or metrics
          enum:
          - NO_AUGMENTATION
          - ACTUALS_AND_METRICS
          nullable: true
          type: string
          x-versionadded: v2.33
        batchIds:
          description: IDs of batches to export. Null for real-time data exports.
          items:
            type: string
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        end:
          description: End of the period of prediction data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
        modelId:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        start:
          description: Start of the period of prediction data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
      required:
      - end
      - start
      type: object
    ExportEntity:
      properties:
        augmentationType:
          default: NO_AUGMENTATION
          description: Indicates if prediction data is augmented with actuals or metrics
          enum:
          - NO_AUGMENTATION
          - ACTUALS_AND_METRICS
          nullable: true
          type: string
          x-versionadded: v2.33
        batches:
          description: Metadata associated with exported batch.
          items:
            $ref: '#/components/schemas/PredictionDataBatch'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        createdAt:
          description: Prediction data export creation timestamp.
          format: date-time
          type: string
          x-versionadded: v2.33
        createdBy:
          description: The user that created prediction data export.
          type: string
          x-versionadded: v2.33
        data:
          description: A prediction data export collected data entries. Available
            only when status is SUCCEEDED.
          items:
            $ref: '#/components/schemas/PredictionDataEntry'
          nullable: true
          type: array
          x-versionadded: v2.33
        error:
          $ref: '#/components/schemas/ExportError'
          description: Error description. Appears when prediction data export job
            failed (status is FAILED).
          nullable: true
          x-versionadded: v2.33
        id:
          description: The ID of the prediction data export.
          type: string
          x-versionadded: v2.33
        modelId:
          description: The ID of the model (or null if not specified).
          type: string
          x-versionadded: v2.33
        period:
          $ref: '#/components/schemas/PredictionDataTimeRange'
          description: A prediction data time range definition.
          x-versionadded: v2.33
        status:
          description: A prediction data export processing state.
          enum:
          - CANCELLED
          - CREATED
          - FAILED
          - SCHEDULED
          - SUCCEEDED
          type: string
          x-versionadded: v2.33
      required:
      - createdAt
      - createdBy
      - id
      - modelId
      - period
      - status
      type: object
    ExportError:
      properties:
        message:
          description: A human readable error message describing failure cause.
          type: string
          x-versionadded: v2.33
      required:
      - message
      type: object
    ExtendedRelationship:
      properties:
        dataset1Identifier:
          description: Identifier of the first dataset in the relationship. If this
            is not provided, it represents the primary dataset.
          maxLength: 20
          minLength: 1
          nullable: true
          type: string
        dataset1Keys:
          description: column(s) in the first dataset that are used to join to the
            second dataset.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        dataset2Identifier:
          description: Identifier of the second dataset in the relationship.
          maxLength: 20
          minLength: 1
          type: string
        dataset2Keys:
          description: column(s) in the second dataset that are used to join to the
            first dataset.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        featureDerivationWindowEnd:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should end. Will be a non-positive integer,
            if present. If present, time-aware joins will be used. Only applicable
            when table1Identifier is not provided.
          maximum: 0
          type: integer
        featureDerivationWindowStart:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should begin. Will be a negative integer, if
            present. If present, time-aware joins will be used. Only applicable when
            table1Identifier is not provided.
          exclusiveMaximum: true
          maximum: 0
          type: integer
        featureDerivationWindowTimeUnit:
          description: Time unit of the feature derivation window. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
            If present, time-aware joins will be used. Only applicable when table1Identifier
            is not provided.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type: string
        featureDerivationWindows:
          description: List of feature derivation window definitions that will be
            used.
          items:
            $ref: '#/components/schemas/FeatureDerivationWindow'
          type: array
          x-versionadded: '2.27'
        predictionPointRounding:
          description: Closest value of predictionPointRoundingTimeUnit to round the
            prediction point into the past when applying the feature derivation window.
            Will be a positive integer, if present. Only applicable when table1Identifier
            is not provided.
          exclusiveMinimum: true
          maximum: 30
          minimum: 0
          type: integer
        predictionPointRoundingTimeUnit:
          description: Time unit of the prediction point rounding. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
            Only applicable when table1Identifier is not provided.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type: string
        relationshipQuality:
          anyOf:
          - $ref: '#/components/schemas/RelationshipQualitySummaryNewFormat'
          - $ref: '#/components/schemas/RelationshipQualitySummary'
          description: Summary of the relationship quality information
      required:
      - dataset1Keys
      - dataset2Identifier
      - dataset2Keys
      type: object
    ExtendedRelationshipsConfigRetrieve:
      properties:
        datasetDefinitions:
          description: List of dataset definitions.
          items:
            $ref: '#/components/schemas/DatasetDefinitionResponse'
          type: array
        featureDiscoveryMode:
          description: Mode of feature discovery. Supported values are 'default' and
            'manual'.
          enum:
          - default
          - manual
          nullable: true
          type: string
        featureDiscoverySettings:
          description: List of feature discovery settings used to customize the feature
            discovery process.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySettingResponse'
          nullable: true
          type: array
        id:
          description: ID of relationships configuration.
          type: string
        relationships:
          description: A list of relationships with quality assessment information
          items:
            $ref: '#/components/schemas/ExtendedRelationship'
          maxItems: 100
          minItems: 1
          type: array
        snowflakePushDownCompatible:
          description: Is this configuration compatible with pushdown computation
            on Snowflake?
          nullable: true
          type: boolean
      required:
      - datasetDefinitions
      - relationships
      type: object
    ExternalNaNPredictionsEventData:
      properties:
        count:
          description: Number of NaN predictions by external model
          exclusiveMinimum: true
          minimum: 0
          type: integer
        modelId:
          default: null
          description: The identifier of the model.
          nullable: true
          type: string
      required:
      - count
      - modelId
      type: object
    ExternalScoresCreate:
      properties:
        actualValueColumn:
          description: Actual value column name that contains actual values to be
            used for computing scores and insights for unsupervised projects only.
            This value can be set once for a dataset and cannot be changed.
          type: string
        datasetId:
          description: The dataset to compute predictions for - must have previously
            been uploaded.
          type: string
        modelId:
          description: The model to use to make predictions.
          type: string
      required:
      - datasetId
      - modelId
      type: object
    ExternalScoresListData:
      properties:
        actualValueColumn:
          description: The name of the column with actuals that was used to calculate
            the scores.
          type: string
        datasetId:
          description: The datasetId the data comes from.
          type: string
        modelId:
          description: The modelId for the scores.
          type: string
        projectId:
          description: The projectId for the scores.
          type: string
        scores:
          description: A json array of the computed scores.
          items:
            $ref: '#/components/schemas/ExternalScoresListDataScore'
          type: array
      required:
      - actualValueColumn
      - datasetId
      - modelId
      - projectId
      - scores
      type: object
    ExternalScoresListDataScore:
      properties:
        label:
          description: The metric name, which was used to compute the score.
          type: string
        value:
          description: The score value.
          type: number
      required:
      - label
      - value
      type: object
    ExternalScoresListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: The list of objects is containing following data.
          items:
            $ref: '#/components/schemas/ExternalScoresListData'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    ExternalTSBaselineMetadata:
      properties:
        datasetId:
          description: Catalog version id for external prediction data that can be
            used as a baseline to calculate new metrics.
          nullable: true
          type: string
        datasetName:
          description: The name of the timeseries baseline dataset for the project
          nullable: true
          type: string
      required:
      - datasetId
      - datasetName
      type: object
    ExternalTSBaselinePayload:
      properties:
        backtests:
          description: An array of the configured backtests.
          items:
            $ref: '#/components/schemas/Backtests'
          maxItems: 20
          minItems: 1
          type: array
        catalogVersionId:
          description: The version id of the external baseline data item in the AI
            catalog.
          type: string
        datetimePartitionColumn:
          description: The date column that will be used as the datetime partition
            column for the specified project.
          type: string
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          type: integer
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          type: integer
        holdoutEndDate:
          description: The end date of holdout scoring data.
          format: date-time
          type: string
        holdoutStartDate:
          description: The start date of holdout scoring data.
          format: date-time
          type: string
        multiseriesIdColumns:
          description: An array of column names identifying the multiseries ID column(s)to
            use to identify series within the data. Must match the multiseries ID
            column(s) for the specified project. Currently, only one multiseries ID
            column may be specified.
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        target:
          description: The selected target of the specified project.
          type: string
      required:
      - catalogVersionId
      - datetimePartitionColumn
      - forecastWindowEnd
      - forecastWindowStart
      - target
      type: object
    ExternalTSBaselineResponse:
      properties:
        backtests:
          description: An array of the configured backtests.
          items:
            $ref: '#/components/schemas/Backtests'
          maxItems: 20
          minItems: 1
          type: array
        baselineValidationJobId:
          description: The id of the validation job.
          type: string
        catalogVersionId:
          description: The version id of the external baseline data item in the AI
            catalog.
          type: string
        datetimePartitionColumn:
          description: The date column that will be used as the datetime partition
            column for the specified project.
          type: string
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          type: integer
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          type: integer
        holdoutEndDate:
          description: The end date of holdout scoring data.
          format: date-time
          type: string
        holdoutStartDate:
          description: The start date of holdout scoring data.
          format: date-time
          type: string
        isExternalBaselineDatasetValid:
          description: Indicates whether the external dataset has pass the validation
            check or not.
          type: boolean
        message:
          description: A message providing mode detail on the validation result.
          nullable: true
          type: string
        multiseriesIdColumns:
          description: An array of column names identifying the multiseries ID column(s)to
            use to identify series within the data. Must match the multiseries ID
            column(s) for the specified project. Currently, only one multiseries ID
            column may be specified.
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        projectId:
          description: The project id of the external baseline data item.
          type: string
        target:
          description: The selected target of the specified project.
          type: string
      required:
      - baselineValidationJobId
      - catalogVersionId
      - datetimePartitionColumn
      - isExternalBaselineDatasetValid
      - message
      - projectId
      - target
      type: object
    FairnessHealth:
      properties:
        protectedClassFailingCount:
          description: Number of protected class below fairness threshold for failing
            status.
          minimum: 1
          type: integer
          x-versionadded: v2.33
        protectedClassWarningCount:
          description: Number of protected class below fairness threshold for warning
            status.
          minimum: 1
          type: integer
          x-versionadded: v2.33
      type: object
    FairnessInsight:
      properties:
        fairnessMetric:
          description: The fairness metric used to calculate the fairness scores.
          enum:
          - proportionalParity
          - equalParity
          - favorableClassBalance
          - unfavorableClassBalance
          - trueUnfavorableRateParity
          - trueFavorableRateParity
          - favorablePredictiveValueParity
          - unfavorablePredictiveValueParity
          type: string
        fairnessThreshold:
          default: 0.8
          description: Value of the fairness threshold, defined in project options.
          maximum: 1.0
          minimum: 0.0
          type: number
        modelId:
          description: ID of the model fairness was measured for.
          type: string
        perClassFairness:
          description: An array of calculated fairness scores for each protected feature
            class.
          items:
            $ref: '#/components/schemas/PerClassFairness'
          type: array
        predictionThreshold:
          description: Model's prediction threshold used when insight was calculated.
            ``null`` if prediction threshold is not required for the fairness metric
            calculations.
          maximum: 1.0
          minimum: 0.0
          type: number
        protectedFeature:
          description: Name of the protected feature the fairness calculation is made
            for.
          type: string
      required:
      - fairnessMetric
      - fairnessThreshold
      - modelId
      - perClassFairness
      - protectedFeature
      type: object
    FairnessInsightsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of fairness insights for the model.
          items:
            $ref: '#/components/schemas/FairnessInsight'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    FairnessInsightsStartCalculationPayload:
      properties:
        fairnessMetricsSet:
          description: Metric to use for calculating fairness. Can be one of ``proportionalParity``,
            ``equalParity``, ``predictionBalance``, ``trueFavorableAndUnfavorableRateParity``
            or ``FavorableAndUnfavorablePredictiveValueParity``. Used and required
            only if *Bias & Fairness in AutoML* feature is enabled.
          enum:
          - proportionalParity
          - equalParity
          - predictionBalance
          - trueFavorableAndUnfavorableRateParity
          - favorableAndUnfavorablePredictiveValueParity
          type: string
          x-versionadded: v2.24
      type: object
    FairnessInsightsStartCalculationResponse:
      properties:
        statusId:
          description: The ID of the status object.
          type: string
      required:
      - statusId
      type: object
    FairnessOverTimeBucket:
      properties:
        metricName:
          description: Name of the metric.
          enum:
          - proportionalParity
          - equalParity
          - favorableClassBalance
          - unfavorableClassBalance
          - trueUnfavorableRateParity
          - trueFavorableRateParity
          - favorablePredictiveValueParity
          - unfavorablePredictiveValueParity
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: Time range for which fairness over time is computed.
        scores:
          description: List of per-feature fairness details.
          items:
            $ref: '#/components/schemas/FairnessOverTimeScore'
          type: array
      required:
      - metricName
      - period
      - scores
      type: object
    FairnessOverTimeResponse:
      properties:
        buckets:
          description: Per bucket summary.
          items:
            $ref: '#/components/schemas/FairnessOverTimeBucket'
          type: array
        fairnessThreshold:
          description: Threshold used to compute fairness results.
          maximum: 1
          minimum: 0
          type: number
        favorableTargetOutcome:
          description: Preferable class of target.
          oneOf:
          - type: boolean
          - type: string
          - type: integer
        modelId:
          description: Model Id for which fairness is computed.
          type: string
        modelPackageId:
          description: Model package Id.
          type: string
        protectedFeature:
          description: Name of the protected feature.
          type: string
        summary:
          $ref: '#/components/schemas/FairnessOverTimeBucket'
          description: Summary of per feature fairness.
      required:
      - buckets
      - fairnessThreshold
      - favorableTargetOutcome
      - modelId
      - modelPackageId
      - summary
      type: object
    FairnessOverTimeScore:
      properties:
        absoluteValue:
          description: Absolute fairness score.
          type: number
        classesCount:
          description: Count of occurences of the class within the data the fairness
            is calculated on.
          type: integer
        healthyClassesCount:
          description: Count of statistically significant classes above fairness threshold.
          type: integer
        healthyCount:
          description: Total number of classes with fairness score above the threshold.
          minimum: 0
          type: integer
        isStatisticallySignificant:
          description: Class is statistically significant.
          type: boolean
        label:
          description: Name of the feature.
          type: string
        message:
          description: Explanation message.
          type: string
        privilegedClass:
          description: Name of the privileged class (the one with the highest fairness
            score) within the feature.
          type: string
        sampleSize:
          description: Sample size used for fairness status calculation
          exclusiveMinimum: true
          minimum: 0
          type: integer
        totalCount:
          description: Total number of classes.
          minimum: 1
          type: integer
        value:
          description: Fairness score in relation to the privileged class fairness
            score.
          maximum: 1
          minimum: 0
          type: number
      type: object
    Feature:
      properties:
        dateFormat:
          description: The date format string for how this feature was interpreted.
          nullable: true
          type: string
        featureType:
          description: Feature type.
          nullable: true
          type: string
        importance:
          description: Numeric measure of the relationship strength between the feature
            and target (independent of model or other features).
          nullable: true
          type: number
        knownInAdvance:
          description: Whether the feature was selected as known in advance in a time-series
            model, false for non-time-series models.
          type: boolean
        name:
          description: Feature name.
          type: string
      required:
      - dateFormat
      - featureType
      - importance
      - knownInAdvance
      - name
      type: object
    FeatureAssociationCreatePayload:
      properties:
        featurelistId:
          description: A featurelist ID to calculate feature association matrix.
          type: string
      required:
      - featurelistId
      type: object
    FeatureAssociationDetailsRetrieveControllerResponse:
      properties:
        chartType:
          description: Which type of plotting the pair of features gets in the UI,
            e.g. `SCATTER`
          type: string
        features:
          description: The name of `feature1` and `feature2`.
          items:
            type: string
          type: array
        types:
          description: 'The type of `feature1` and `feature2`. Possible values: `CATEGORICAL`,
            `NUMERIC`.'
          items:
            enum:
            - CATEGORICAL
            - NUMERIC
            type: string
          type: array
        values:
          description: The data triplets for pairwise plotting.
          items:
            items:
              anyOf:
              - type: string
              - type: number
            type: array
          type: array
      required:
      - chartType
      - features
      - types
      - values
      type: object
    FeatureAssociationList:
      properties:
        featurelistId:
          description: The featurelist Id.
          type: string
        hasFam:
          description: Whether Feature Association Matrix is calculated for featurelist.
          type: boolean
        title:
          description: The name of featurelist.
          type: string
      required:
      - featurelistId
      - hasFam
      - title
      type: object
    FeatureAssociationListControllerResponse:
      properties:
        featurelists:
          description: List all featurelists with feature association matrix availability
            flags.
          items:
            $ref: '#/components/schemas/FeatureAssociationList'
          type: array
      required:
      - featurelists
      type: object
    FeatureAssociationRetrieveControllerResponse:
      properties:
        features:
          description: Metadata for each feature and where it goes in the matrix as
            structured below.
          items:
            $ref: '#/components/schemas/FeatureAssociationRetrieveFeatures'
          type: array
        strengths:
          description: Pairwise statistics for the available features as structured
            below.
          items:
            $ref: '#/components/schemas/FeatureAssociationRetrieveStrengths'
          type: array
      required:
      - features
      - strengths
      type: object
    FeatureAssociationRetrieveFeatures:
      properties:
        alphabeticSortIndex:
          description: A number representing the alphabetical order of this feature
            compared to the other features in this dataset.
          type: integer
        clusterId:
          description: ID of the cluster this feature belongs to.
          nullable: true
          type: integer
        clusterName:
          description: Name of feature cluster.
          type: string
        clusterSortIndex:
          description: A number representing the ordering of the feature across all
            feature clusters. Features in the same cluster always have adjacent indices.
          type: integer
        feature:
          description: Name of the feature.
          type: string
        importanceSortIndex:
          description: A number ranking the importance of this feature compared to
            the other features in this dataset.
          type: integer
        strengthSortIndex:
          description: A number ranking the strength of this feature compared to the
            other features in this dataset.
          type: integer
      required:
      - alphabeticSortIndex
      - clusterId
      - clusterSortIndex
      - feature
      - importanceSortIndex
      - strengthSortIndex
      type: object
    FeatureAssociationRetrieveStrengths:
      properties:
        feature1:
          description: The name of the first feature.
          type: string
        feature2:
          description: The name of the second feature.
          type: string
        statistic:
          description: Feature association statistics for `feature1` and `feature2`.
            For features with no pairwise statistics available the value is `null`.
          nullable: true
          type: number
      required:
      - feature1
      - feature2
      - statistic
      type: object
    FeatureCountByTypeResponse:
      properties:
        count:
          description: The number of features of this type in the dataset
          type: integer
        featureType:
          description: The data type grouped in this count
          type: string
      required:
      - count
      - featureType
      type: object
    FeatureCounts:
      properties:
        count:
          description: Number of times the class was encountered.
          type: integer
        label:
          description: Name of the class.
          type: string
      required:
      - count
      - label
      type: object
    FeatureDerivationWindow:
      properties:
        end:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should end. Will be a non-positive integer,
            if present. If present, time-aware joins will be used. Only applicable
            when table1Identifier is not provided.
          maximum: 0
          type: integer
          x-versionadded: '2.27'
        start:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should begin. Will be a negative integer, if
            present. If present, time-aware joins will be used. Only applicable when
            table1Identifier is not provided.
          exclusiveMaximum: true
          maximum: 0
          type: integer
          x-versionadded: '2.27'
        unit:
          description: Time unit of the feature derivation window. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
            If present, time-aware joins will be used. Only applicable when table1Identifier
            is not provided.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type: string
          x-versionadded: '2.27'
      required:
      - end
      - start
      - unit
      type: object
    FeatureDiscoveryLogListResponse:
      properties:
        count:
          description: Number of items returned on this page
          type: integer
        featureDiscoveryLog:
          description: List of lines retrieved from the feature discovery log
          items:
            type: string
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalLogLines:
          description: total number of lines in feature derivation log
          type: integer
      required:
      - count
      - featureDiscoveryLog
      - next
      - previous
      - totalLogLines
      type: object
    FeatureDiscoveryRecipeSQLsExport:
      properties:
        modelId:
          description: Model ID to export recipe for
          type: string
      type: object
    FeatureDiscoverySetting:
      properties:
        name:
          description: Name of this feature discovery setting
          maxLength: 100
          type: string
        value:
          description: Value of this feature discovery setting
          type: boolean
      required:
      - name
      - value
      type: object
    FeatureDiscoverySettingResponse:
      properties:
        description:
          description: Description of this feature discovery setting
          type: string
        family:
          description: Family of this feature discovery setting
          type: string
        name:
          description: Name of this feature discovery setting
          maxLength: 100
          type: string
        settingType:
          description: Type of this feature discovery setting
          type: string
        value:
          description: Value of this feature discovery setting
          type: boolean
        verboseName:
          description: Human readable name of this feature discovery setting
          type: string
      required:
      - description
      - family
      - name
      - settingType
      - value
      - verboseName
      type: object
    FeatureDrift:
      properties:
        baselineSampleSize:
          description: The sample size of the training data.
          type: integer
        driftScore:
          description: The drift score for this feature.
          nullable: true
          type: number
        featureImpact:
          description: The feature impact score for this feature.
          type: number
        name:
          description: The name of the feature.
          type: string
        sampleSize:
          description: The number of predictions used to compute the drift score.
          type: integer
        type:
          description: Type of the feature.
          enum:
          - numeric
          - categorical
          - text
          type: string
          x-versionadded: v2.30
      required:
      - baselineSampleSize
      - driftScore
      - featureImpact
      - name
      - sampleSize
      - type
      type: object
    FeatureDriftOverBatchBucket:
      properties:
        baselineSampleSize:
          description: The sample size in the baseline used to calculate drift score.
          type: integer
          x-versionadded: v2.33
        batch:
          $ref: '#/components/schemas/DriftBatch'
          description: Info of the batch associated with the bucket.
          x-versionadded: v2.33
        driftScore:
          description: Drift score of the feature.
          nullable: true
          type: number
          x-versionadded: v2.33
        featureImpact:
          description: The feature impact score of the feature.
          type: number
          x-versionadded: v2.33
        featureName:
          description: Feature name.
          type: string
          x-versionadded: v2.33
        sampleSize:
          description: The sample size in the batch used to calculate drift score.
          type: integer
          x-versionadded: v2.33
      required:
      - baselineSampleSize
      - batch
      - driftScore
      - featureImpact
      - featureName
      - sampleSize
      type: object
    FeatureDriftOverBatchResponse:
      properties:
        buckets:
          description: A list of buckets to display feature drift over batch.
          items:
            $ref: '#/components/schemas/FeatureDriftOverBatchBucket'
          type: array
          x-versionadded: v2.33
        driftMetric:
          description: The metric used to calculate data drift scores.
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          type: string
          x-versionadded: v2.33
      required:
      - buckets
      type: object
    FeatureDriftOverTimeBucket:
      properties:
        baselineSampleSize:
          description: The sample size of the training data used during model creation
          type: integer
        driftScore:
          description: The aggregated drift score for the target.
          nullable: true
          type: number
        featureImpact:
          description: The feature impact score of the feature.
          type: number
        featureName:
          description: Name of the feature.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: Time range for which feature drift is computed.
        sampleSize:
          description: The sample size in the query period used to calculate drift
            score.
          type: integer
      required:
      - baselineSampleSize
      - driftScore
      - featureImpact
      - featureName
      - period
      - sampleSize
      type: object
    FeatureDriftOverTimeFeature:
      properties:
        featureName:
          description: Name of the requested feature.
          type: string
        featureType:
          description: Data type of the requested feature.
          enum:
          - numeric
          - categorical
          - text
          type: string
      required:
      - featureName
      - featureType
      type: object
    FeatureDriftOverTimeResponse:
      properties:
        buckets:
          description: A list of aggregated drift scores by feature over a given period.
          items:
            $ref: '#/components/schemas/FeatureDriftOverTimeBucket'
          type: array
        features:
          description: A list of the requested features and their feature type.
          items:
            $ref: '#/components/schemas/FeatureDriftOverTimeFeature'
          type: array
        metric:
          description: Name of requested metric.
          type: string
        summaries:
          description: A list of aggregated drift scores by feature over a given period.
          items:
            $ref: '#/components/schemas/FeatureDriftOverTimeSummary'
          type: array
      required:
      - buckets
      - features
      - metric
      - summaries
      type: object
    FeatureDriftOverTimeSummary:
      properties:
        featureImpact:
          description: The feature impact score of the feature.
          type: number
        featureName:
          description: Name of the feature.
          type: string
      required:
      - featureImpact
      - featureName
      type: object
    FeatureDriftResponse:
      properties:
        batchId:
          default: []
          description: The id of the batch for which metrics are being retrieved.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array [DriftObject], each in the form described below
          items:
            $ref: '#/components/schemas/FeatureDrift'
          type: array
        metric:
          description: Metric used to calculate drift score.
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          type: string
        modelId:
          description: The id of the model for which the features drift is being retrieved.
          type: string
        next:
          description: A URL pointing to the next page (if null, there is no next
            page)
          nullable: true
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: An object with the keys "start" and "end" defining the period
            to retrieve features drift.
        previous:
          description: A URL pointing to the previous page (if null, there is no previous
            page)
          nullable: true
          type: string
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
        segmentValue:
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
      required:
      - data
      - modelId
      type: object
    FeatureDriftSetting:
      properties:
        enabled:
          description: Indicates whether feature drift tracking is enabled for this
            deployment.
          type: boolean
      required:
      - enabled
      type: object
    FeatureDriftUpdate:
      properties:
        enabled:
          description: True if feature drift tracking is enabled for this deployment,
            false if otherwise.
          type: boolean
      required:
      - enabled
      type: object
    FeatureEffectCreate:
      properties:
        rowCount:
          description: The number of rows from dataset to use for Feature Impact calculation.
          maximum: 100000
          minimum: 10
          nullable: true
          type: integer
          x-versionadded: v2.21
      type: object
    FeatureEffects:
      properties:
        featureImpactScore:
          description: Feature impact score.
          type: number
        featureName:
          description: Name of the feature.
          type: string
        featureType:
          description: Feature type, either numeric or categorical.
          type: string
        isBinnable:
          description: Whether values can be grouped into bins.
          type: boolean
        isScalable:
          description: Whether numeric feature values can be reported on a log scale.
          nullable: true
          type: boolean
        partialDependence:
          $ref: '#/components/schemas/PartialDependence'
          description: Partial dependence results. Can be missing if no data for the
            feature was qualified to generate the insight.
        predictedVsActual:
          $ref: '#/components/schemas/PredictedVsActual'
          description: Predicted versus actual results. Can be missing if no data
            for the feature was qualified to generate the insight.
        weightLabel:
          description: Weight label if weight was configured for the project.
          nullable: true
          type: string
      required:
      - featureImpactScore
      - featureName
      - featureType
      - isBinnable
      - isScalable
      - weightLabel
      type: object
    FeatureEffectsCreateDatetime:
      properties:
        backtestIndex:
          description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
            `startstop`.'
          type: string
        rowCount:
          description: The number of rows from dataset to use for Feature Impact calculation.
          maximum: 100000
          minimum: 10
          nullable: true
          type: integer
          x-versionadded: v2.21
      required:
      - backtestIndex
      type: object
    FeatureEffectsDatetimeResponse:
      properties:
        backtestIndex:
          description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
            `startstop`.'
          type: string
        featureEffects:
          description: Feature Effects computational results for each feature.
          items:
            $ref: '#/components/schemas/FeatureEffects'
          type: array
        modelId:
          description: The model ID
          type: string
        projectId:
          description: The project ID
          type: string
        source:
          description: Models data source.
          type: string
      required:
      - backtestIndex
      - featureEffects
      - modelId
      - projectId
      - source
      type: object
    FeatureEffectsInsightResponse:
      properties:
        featureEffects:
          description: Feature Effects computational results for each feature.
          items:
            $ref: '#/components/schemas/FeatureEffects'
          type: array
      required:
      - featureEffects
      type: object
    FeatureEffectsResponse:
      properties:
        featureEffects:
          description: Feature Effects computational results for each feature.
          items:
            $ref: '#/components/schemas/FeatureEffects'
          type: array
        modelId:
          description: The model ID
          type: string
        projectId:
          description: The project ID
          type: string
        source:
          description: Models data source.
          type: string
      required:
      - featureEffects
      - modelId
      - projectId
      - source
      type: object
    FeatureFlagObject:
      properties:
        uiLabel:
          description: String representation of the feature flag
          type: string
        uiTooltip:
          description: Detailed description of the feature flag
          type: string
        value:
          description: Value of the feature flag
          type: boolean
      required:
      - value
      type: object
    FeatureHistogramPlotResponse:
      properties:
        count:
          description: number of values in the bin (or weights if project is weighted)
          type: number
        label:
          description: bin start for numerical/uncapped, or string value for categorical.
            The bin `==Missing==` is created for rows that did not have the feature.
          type: string
        target:
          description: Average value of the target feature values for the bin. For
            regression projects, it will be null, if the feature was deemed as low
            informative or project target has not been selected yet or AIM processing
            has not finished yet. You can use :http:get:`/api/v2/projects/(projectId)/features/`
            endpoint to find more about low informative features. For binary classification,
            the same conditions apply as above, but the value should be treated as
            the ratio of total positives in the bin to bin's total size (`count`).
            For multiclass projects the value is always null.
          nullable: true
          type: number
      required:
      - count
      - label
      - target
      type: object
    FeatureHistogramResponse:
      properties:
        plot:
          description: plot data based on feature values.
          items:
            $ref: '#/components/schemas/FeatureHistogramPlotResponse'
          type: array
      required:
      - plot
      type: object
    FeatureImpactCreatePayload:
      properties:
        rowCount:
          description: The sample size to use for Feature Impact computation. It is
            possible to re-compute Feature Impact with a different row count.
          maximum: 100000
          minimum: 10
          type: integer
          x-versionadded: v2.21
      type: object
    FeatureImpactCreateResponse:
      properties:
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            for tracking job status.
          type: string
      required:
      - statusId
      type: object
    FeatureImpactInsightResponse:
      properties:
        featureImpacts:
          description: A list which contains feature impact scores for each feature
            used by a model. If the model has more than 1000 features, the most important
            1000 features are returned.
          items:
            $ref: '#/components/schemas/FeatureImpactItem'
          maxItems: 1000
          type: array
        ranRedundancyDetection:
          description: Indicates whether redundant feature identification was run
            while calculating this feature impact.
          type: boolean
        rowCount:
          description: The number of rows that was used to calculate feature impact.
            For the feature impact calculated with the default logic, without specifying
            the ``rowCount``, we return ``null`` here.
          nullable: true
          type: integer
      required:
      - featureImpacts
      - ranRedundancyDetection
      - rowCount
      type: object
    FeatureImpactItem:
      properties:
        featureName:
          description: The name of the feature.
          type: string
        impactNormalized:
          description: The same as `impactUnnormalized`, but normalized such that
            the highest value is `1`.
          maximum: 1
          type: number
        impactUnnormalized:
          description: How much worse the error metric score is when making predictions
            on modified data.
          type: number
        parentFeatureName:
          description: The name of the parent feature.
          nullable: true
          type: string
        redundantWith:
          description: Name of feature that has the highest correlation with this
            feature.
          nullable: true
          type: string
      required:
      - featureName
      - impactNormalized
      - impactUnnormalized
      - redundantWith
      type: object
    FeatureImpactResponse:
      properties:
        count:
          description: Number of feature impact records in a given batch.
          type: integer
        featureImpacts:
          description: A list which contains feature impact scores for each feature
            used by a model. If the model has more than 1000 features, the most important
            1000 features are returned.
          items:
            $ref: '#/components/schemas/FeatureImpactItem'
          maxItems: 1000
          type: array
        next:
          description: URL for the next page of results or `null`.
          format: uri
          nullable: true
          type: string
        previous:
          description: URL for the next page of results or `null`.
          format: uri
          nullable: true
          type: string
        ranRedundancyDetection:
          description: Indicates whether redundant feature identification was run
            while calculating this feature impact.
          type: boolean
        rowCount:
          description: The number of rows that was used to calculate feature impact.
            For the feature impact calculated with the default logic, without specifying
            the ``rowCount``, we return ``null`` here.
          nullable: true
          type: integer
          x-versionadded: v2.21
        shapBased:
          description: 'Indicates whether feature impact was calculated using Shapley
            values. True for anomaly detection models when the project is unsupervised,
            as permutation approach is not applicable. Note that supervised projects
            must use an alternative route for SHAP impact: /api/v2/projects/(projectId)/models/(modelId)/shapImpact/'
          type: boolean
          x-versionadded: v2.18
      required:
      - count
      - featureImpacts
      - next
      - previous
      - ranRedundancyDetection
      - rowCount
      - shapBased
      type: object
    FeatureKeySummaryDetailsResponseValidatorMultilabel:
      properties:
        max:
          description: Maximum value of the key.
          type: number
        mean:
          description: Mean value of the key.
          type: number
        median:
          description: Median value of the key.
          type: number
        min:
          description: Minimum value of the key.
          type: number
        pctRows:
          description: Percentage occurrence of key in the EDA sample of the feature.
          type: number
        stdDev:
          description: Standard deviation of the key.
          type: number
      required:
      - max
      - mean
      - median
      - min
      - pctRows
      - stdDev
      type: object
    FeatureKeySummaryDetailsResponseValidatorSummarizedCategorical:
      properties:
        dataQualities:
          description: The indicator of data quality assessment of the feature.
          enum:
          - ISSUES_FOUND
          - NOT_ANALYZED
          - NO_ISSUES_FOUND
          type: string
          x-versionadded: v2.20
        max:
          description: Maximum value of the key.
          type: number
        mean:
          description: Mean value of the key.
          type: number
        median:
          description: Median value of the key.
          type: number
        min:
          description: Minimum value of the key.
          type: number
        pctRows:
          description: Percentage occurrence of key in the EDA sample of the feature.
          type: number
        stdDev:
          description: Standard deviation of the key.
          type: number
      required:
      - dataQualities
      - max
      - mean
      - median
      - min
      - pctRows
      - stdDev
      type: object
    FeatureKeySummaryResponseValidatorMultilabel:
      properties:
        key:
          description: Name of the key.
          type: string
        summary:
          $ref: '#/components/schemas/FeatureKeySummaryDetailsResponseValidatorMultilabel'
          description: Statistics of the key.
      required:
      - key
      - summary
      type: object
    FeatureKeySummaryResponseValidatorSummarizedCategorical:
      properties:
        key:
          description: Name of the key.
          type: string
        summary:
          $ref: '#/components/schemas/FeatureKeySummaryDetailsResponseValidatorSummarizedCategorical'
          description: Statistics of the key.
      required:
      - key
      - summary
      type: object
    FeatureLineageJoin:
      properties:
        joinType:
          description: Kind of SQL JOIN applied.
          enum:
          - left, right
          type: string
        leftTable:
          $ref: '#/components/schemas/FeatureLineageJoinTable'
          description: Information about a dataset which was considered left in a
            join.
        rightTable:
          $ref: '#/components/schemas/FeatureLineageJoinTable'
          description: Information about a dataset which was considered right in a
            join.
      required:
      - joinType
      - leftTable
      - rightTable
      type: object
    FeatureLineageJoinTable:
      properties:
        columns:
          description: List of columns which datasets were joined by.
          items:
            type: string
          minItems: 1
          type: array
        datasteps:
          description: List of *data* steps id which brought the *columns* into the
            current step dataset.
          items:
            minimum: 1
            type: integer
          type: array
      required:
      - columns
      - datasteps
      type: object
    FeatureLineageResponse:
      properties:
        steps:
          description: List of steps which were applied to build the feature.
          items:
            $ref: '#/components/schemas/FeatureLineageStep'
          type: array
      required:
      - steps
      type: object
    FeatureLineageStep:
      properties:
        arguments:
          description: Generic key-value pairs to describe **action** step additional
            parameters.
          type: object
        catalogId:
          description: id of the catalog for a **data** step.
          type: string
        catalogVersionId:
          description: id of the catalog version for a **data** step.
          type: string
        description:
          description: Description of the step.
          type: string
        groupBy:
          description: List of columns which this **action** step aggregated.
          items:
            type: string
          type: array
        id:
          description: Step id starting with 0.
          minimum: 0
          type: integer
        isTimeAware:
          description: Indicator of step being time aware. Mandatory only for **action**
            and **join** steps. **action** step provides additional information about
            feature derivation window in the `timeInfo` field.
          type: boolean
        joinInfo:
          $ref: '#/components/schemas/FeatureLineageJoin'
          description: '**join** step details.'
        name:
          description: Name of the step.
          type: string
        parents:
          description: '`id` of steps which use this step output as their input.'
          items:
            minimum: 0
            type: integer
          type: array
        stepType:
          description: One of four types of a step. **data** - source features. **action**
            - data aggregation or trasformation. **join** - SQL JOIN. **generatedData**
            - final feature. There is always one **generatedData** step and at least
            one **data** step.
          enum:
          - data
          - action
          - join
          - generatedData
          type: string
        timeInfo:
          $ref: '#/components/schemas/FeatureLineageTimeInfo'
          description: Description of a feature derivation window which was applied
            to this **action** step.
      required:
      - id
      - parents
      - stepType
      type: object
    FeatureLineageTimeInfo:
      properties:
        duration:
          $ref: '#/components/schemas/TimeDelta'
          description: Size of the feature derivation window applied.
        latest:
          $ref: '#/components/schemas/TimeDelta'
          description: End of the feature derivation window applied.
      required:
      - duration
      - latest
      type: object
    FeatureListCreate:
      properties:
        description:
          description: Description of the featurelist
          type: string
        features:
          description: List of names of features to be included in the new featurelist,
            all features listed must be part of the universe. All features for this
            dataset for the request to succeed.
          items:
            type: string
          minItems: 1
          type: array
        name:
          description: Name of the featurelist to be created
          type: string
      required:
      - features
      - name
      type: object
    FeatureListModify:
      properties:
        description:
          description: The new description of the featurelist
          nullable: true
          type: string
        name:
          description: The new name of the featurelist.
          type: string
      type: object
    FeatureListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of dataset details.
          items:
            $ref: '#/components/schemas/Feature'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    FeatureMetricDetailsResponse:
      properties:
        ascending:
          description: Should the metric be sorted in ascending order
          type: boolean
        metricName:
          description: Name of the metric
          type: string
        supportsBinary:
          description: This metric is valid for binary classifciaton
          type: boolean
        supportsMulticlass:
          description: This metric is valid for mutliclass classifciaton
          type: boolean
        supportsRegression:
          description: This metric is valid for regression
          type: boolean
        supportsTimeseries:
          description: This metric is valid for timeseries
          type: boolean
      required:
      - ascending
      - metricName
      - supportsBinary
      - supportsMulticlass
      - supportsRegression
      - supportsTimeseries
      type: object
    FeatureMetricsResponse:
      properties:
        availableMetrics:
          description: an array of strings representing the appropriate metrics.  If
            the feature cannot be selected as the target, then this array will be
            empty.
          items:
            type: string
          type: array
        featureName:
          description: the name of the feature that was looked up
          type: string
        metricDetails:
          description: the list of metricDetails objects.
          items:
            $ref: '#/components/schemas/FeatureMetricDetailsResponse'
          type: array
      required:
      - availableMetrics
      - featureName
      - metricDetails
      type: object
    FeatureSetting:
      properties:
        aPriori:
          description: Renamed to `knownInAdvance`.
          type: boolean
          x-versiondeprecated: v2.11
        doNotDerive:
          description: For time series projects only. Sets whether the feature is
            do-not-derive, i.e., is excluded from feature derivation. If not specified,
            the feature uses the value from the `defaultToDoNotDerive` flag.
          type: boolean
        featureName:
          description: The name of the feature being specified.
          type: string
        knownInAdvance:
          description: For time series projects only. Sets whether the feature is
            known in advance, i.e., values for future dates are known at prediction
            time. If not specified, the feature uses the value from the `defaultToKnownInAdvance`
            flag.
          type: boolean
      required:
      - featureName
      type: object
    FeatureTransform:
      properties:
        dateExtraction:
          description: 'The value to extract from the date column, of these options:
            `[year|yearDay|month|monthDay|week|weekDay]`. Required for transformation
            of a date column. Otherwise must not be provided.'
          enum:
          - year
          - yearDay
          - month
          - monthDay
          - week
          - weekDay
          type: string
        name:
          description: The name of the new feature. Must not be the same as any existing
            features for this project. Must not contain '/' character.
          type: string
        parentName:
          description: The name of the parent feature.
          type: string
        replacement:
          anyOf:
          - nullable: true
            type: string
          - nullable: true
            type: boolean
          - nullable: true
            type: number
          - nullable: true
            type: integer
          description: The replacement in case of a failed transformation.
        variableType:
          description: The type of the new feature. Must be one of `text`, `categorical`
            (Deprecated in version v2.21), `numeric`, or `categoricalInt`. See the
            description of this method for more information.
          enum:
          - text
          - categorical
          - numeric
          - categoricalInt
          type: string
      required:
      - name
      - parentName
      - variableType
      type: object
    FeaturelistDestroyResponse:
      properties:
        canDelete:
          description: Whether the featurelist can be deleted.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        deletionBlockedReason:
          description: If the featurelist can't be deleted, this explains why.
          type: string
        dryRun:
          description: Whether this was a dry-run or the featurelist was actually
            deleted.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        numAffectedJobs:
          description: Number of incomplete jobs using this featurelist.
          type: integer
        numAffectedModels:
          description: Number of models using this featurelist.
          type: integer
      required:
      - canDelete
      - deletionBlockedReason
      - dryRun
      - numAffectedJobs
      - numAffectedModels
      type: object
    FeaturelistListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of modeling features.
          items:
            $ref: '#/components/schemas/FeaturelistResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    FeaturelistResponse:
      properties:
        created:
          description: A :ref:`timestamp <time_format>` string specifying when the
            featurelist was created.
          type: string
          x-versionadded: v2.13
        description:
          description: User-friendly description of the featurelist, which can be
            updated by users.
          nullable: true
          type: string
          x-versionadded: v2.13
        features:
          description: Names of features included in the featurelist.
          items:
            type: string
          type: array
        id:
          description: Featurelist ID.
          type: string
        isUserCreated:
          description: Whether the featurelist was created manually by a user or by
            DataRobot automation.
          type: boolean
          x-versionadded: v2.13
        name:
          description: the name of the featurelist
          type: string
        numModels:
          description: The number of models that currently use this featurelist. A
            model is considered to use a featurelist if it is used to train the model
            or as a monotonic constraint featurelist, or if the model is a blender
            with at least one component model using the featurelist.
          type: integer
          x-versionadded: v2.13
        projectId:
          description: Project ID the featurelist belongs to.
          type: string
      required:
      - created
      - features
      - id
      - isUserCreated
      - name
      - numModels
      - projectId
      type: object
    FileSystemDataStreamer:
      properties:
        path:
          description: Path to data on host filesystem
          type: string
        type:
          description: Type name for this intake type
          enum:
          - filesystem
          type: string
      required:
      - path
      - type
      type: object
    FileSystemIntake:
      properties:
        path:
          description: Path to data on host filesystem
          type: string
        type:
          description: Type name for this intake type
          enum:
          - filesystem
          type: string
      required:
      - path
      - type
      type: object
    FileSystemOutput:
      properties:
        path:
          description: Path to results on host filesystem
          type: string
        type:
          description: Type name for this output type
          enum:
          - filesystem
          type: string
      required:
      - path
      - type
      type: object
    FileSystemOutputAdaptor:
      properties:
        path:
          description: Path to results on host filesystem
          type: string
        type:
          description: Type name for this output type
          enum:
          - filesystem
          type: string
      required:
      - path
      - type
      type: object
    FilterCondition:
      properties:
        column:
          description: The column name.
          type: string
          x-versionadded: v2.33
        function:
          description: The function used to evaluate each value.
          enum:
          - between
          - contains
          - eq
          - gt
          - gte
          - lt
          - lte
          - neq
          - notnull
          - 'null'
          type: string
          x-versionadded: v2.33
        functionArguments:
          default: []
          description: The arguments to use with the function.
          items:
            anyOf:
            - type: string
            - type: integer
            - type: number
          maxItems: 2
          type: array
          x-versionadded: v2.33
      required:
      - column
      - function
      type: object
    FilterDataSlices:
      properties:
        operand:
          description: Feature to apply operation to.
          type: string
        operator:
          description: Operator to apply to the named operand in the dataset. The
            operator 'eq' mean 'equals the single specified value'. The operator 'in'
            means 'is one of a list of allowed values.'
          enum:
          - eq
          - in
          - <
          - '>'
          - between
          - notBetween
          type: string
        values:
          description: Values to filter the operand by with the given operator.
          items:
            anyOf:
            - type: string
            - type: integer
            - type: number
          maxItems: 1000
          minItems: 1
          type: array
      required:
      - operand
      - operator
      - values
      type: object
    FilterDirectiveArguments:
      properties:
        conditions:
          description: The list of conditions.
          items:
            $ref: '#/components/schemas/FilterCondition'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        keepRows:
          default: true
          description: Determines whether matching rows should be kept or dropped.
          type: boolean
          x-versionadded: v2.33
        operator:
          default: and
          description: The operator to apply on multiple conditions.
          enum:
          - and
          - or
          type: string
          x-versionadded: v2.33
      required:
      - conditions
      - keepRows
      - operator
      type: object
    FinalBacktestResponse:
      properties:
        availableTrainingDuration:
          description: The duration of the available training data for this backtest.
          format: duration
          type: string
        availableTrainingEndDate:
          description: The end date of the available training data for this backtest.
          format: date-time
          type: string
        availableTrainingRowCount:
          description: The number of rows in the available training data for this
            backtest.
          type: integer
        availableTrainingStartDate:
          description: The start date of the available training data for this backtest.
          format: date-time
          type: string
        gapDuration:
          description: The duration of the gap between the training and the validation
            scoring data for this backtest.
          format: duration
          type: string
        gapEndDate:
          description: The end date of the gap between the training and validation
            scoring data for this backtest.
          format: date-time
          type: string
        gapRowCount:
          description: The number of rows in the gap between the training and the
            validation scoring data for this backtest.
          type: integer
        gapStartDate:
          description: The start date of the gap between the training and validation
            scoring data for this backtest.
          format: date-time
          type: string
        index:
          description: The index from zero of this backtest.
          type: integer
        primaryTrainingDuration:
          description: The duration of the primary training data for this backtest.
          format: duration
          type: string
        primaryTrainingEndDate:
          description: The end date of the primary training data for this backtest.
          format: date-time
          type: string
        primaryTrainingRowCount:
          description: The number of rows in the primary training data for this backtest.
          type: integer
        primaryTrainingStartDate:
          description: The start date of the primary training data for this backtest.
          format: date-time
          type: string
        totalRowCount:
          description: The total number of rows in this backtest
          type: integer
        validationDuration:
          description: The duration of the validation scoring data for this backtest.
          type: string
        validationEndDate:
          description: The end date of the validation scoring data for this backtest.
          format: date-time
          type: string
        validationRowCount:
          description: The number of rows in the validation scoring data for this
            backtest.
          type: integer
        validationStartDate:
          description: The start date of the validation scoring data for this backtest.
          format: date-time
          type: string
      required:
      - availableTrainingDuration
      - availableTrainingEndDate
      - availableTrainingRowCount
      - availableTrainingStartDate
      - gapDuration
      - gapEndDate
      - gapRowCount
      - gapStartDate
      - index
      - primaryTrainingDuration
      - primaryTrainingEndDate
      - primaryTrainingRowCount
      - primaryTrainingStartDate
      - totalRowCount
      - validationDuration
      - validationEndDate
      - validationRowCount
      - validationStartDate
      type: object
    FinalDatetimePartitioningResponse:
      properties:
        aggregationType:
          description: For multiseries projects only. The aggregation type to apply
            when creating cross-series features.
          enum:
          - total
          - average
          nullable: true
          type: string
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          description: Specifies whether the time series predictions can use partial
            historical data.
          nullable: true
          type: boolean
          x-versionadded: v2.31
        autopilotDataSamplingMethod:
          description: The Data Sampling method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - random
          - latest
          type: string
        autopilotDataSelectionMethod:
          description: The Data Selection method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - duration
          - rowCount
          type: string
        availableHoldoutEndDate:
          description: The maximum valid date of holdout scoring data.
          format: date-time
          nullable: true
          type: string
        availableTrainingDuration:
          description: The duration of available training duration for scoring the
            holdout.
          format: duration
          type: string
        availableTrainingEndDate:
          description: The end date of available training data for scoring the holdout.
          format: date-time
          type: string
        availableTrainingRowCount:
          description: The number of rows in the available training data for scoring
            the holdout
          type: integer
        availableTrainingStartDate:
          description: The start date of available training data for scoring the holdout.
          format: date-time
          type: string
        backtests:
          description: An array of the configured backtests.
          items:
            $ref: '#/components/schemas/FinalBacktestResponse'
          maxItems: 20
          minItems: 1
          type: array
        calendarId:
          description: The ID of the calendar to be used in this project.
          nullable: true
          type: string
          x-versionadded: v2.15
        calendarName:
          description: The name of the calendar used in this project.
          nullable: true
          type: string
          x-versionadded: v2.17
        crossSeriesGroupByColumns:
          description: For multiseries projects with cross-series features enabled
            only. List of columns (currently of length 1). Setting that indicates
            how to further split series into related groups. For example, if every
            series is sales of an individual product, the series group-by could be
            the product category with values like "men's clothing", "sports equipment",
            etc.
          items:
            type: string
          maxItems: 1
          nullable: true
          type: array
          x-versionadded: v2.15
        dateFormat:
          description: The date format of the partition column.
          type: string
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column.
          type: string
        datetimePartitioningId:
          description: The ID of the current optimized datetime partitioning
          type: string
          x-versionadded: v2.30
        defaultToAPriori:
          description: Renamed to `defaultToKnownInAdvance`.
          type: boolean
          x-versiondeprecated: v2.11
        defaultToDoNotDerive:
          description: For time series projects only. Sets whether all features default
            to being treated as do-not-derive features, excluding them from feature
            derivation. Individual features can be set to a value different than the
            default by using the `featureSettings` parameter.
          type: boolean
          x-versionadded: v2.17
        defaultToKnownInAdvance:
          description: For time series projects only. Sets whether all features default
            to being treated as known in advance features, which are features that
            are known into the future. Features marked as known in advance must be
            specified into the future when making predictions. The default is false,
            all features are not known in advance. Individual features can be set
            to a value different than the default using the `featureSettings` parameter.
            See the :ref:`Time Series Overview <time_series_overview>` for more context.
          type: boolean
          x-versionadded: v2.11
        differencingMethod:
          description: For time series projects only. Used to specify which differencing
            method to apply if the data is stationary. For classification problems
            `simple` and `seasonal` are not allowed. Parameter `periodicities` must
            be specified if `seasonal` is chosen. Defaults to `auto`.
          enum:
          - auto
          - none
          - simple
          - seasonal
          nullable: true
          type: string
          x-versionadded: v2.9
        disableHoldout:
          description: A boolean value indicating whether date partitioning skipped
            allocating a holdout fold.
          type: boolean
          x-versionadded: v2.8
        featureDerivationWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should end.
          maximum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        featureDerivationWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should begin.
          maximum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        featureSettings:
          description: An array specifying per feature settings. Features can be left
            unspecified.
          items:
            $ref: '#/components/schemas/FeatureSetting'
          type: array
          x-versionadded: v2.9
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.8
        gapDuration:
          description: The duration of the gap between the training and holdout scoring
            data.
          format: duration
          type: string
        gapEndDate:
          description: The end date of the gap between the training and holdout scoring
            data.
          format: date-time
          type: string
        gapRowCount:
          description: The number of rows in the gap between the training and holdout
            scoring data
          type: integer
        gapStartDate:
          description: The start date of the gap between the training and holdout
            scoring data.
          format: date-time
          type: string
        holdoutDuration:
          description: The duration of the holdout scoring data.
          format: duration
          type: string
        holdoutEndDate:
          description: The end date of holdout scoring data.
          format: date-time
          type: string
        holdoutRowCount:
          description: The number of rows in the holdout scoring data
          type: integer
        holdoutStartDate:
          description: The start date of holdout scoring data.
          format: date-time
          type: string
        isHoldoutModified:
          description: A boolean value indicating whether holdout settings (start/end
            dates) have been modified by user.
          type: boolean
        modelSplits:
          description: 'Sets the cap on the number of jobs per model used when building
            models to control number of jobs in the queue. Higher number of modelSplits
            will allow for less downsampling leading to the use of more post-processed
            data. '
          maximum: 10
          minimum: 1
          nullable: true
          type: integer
          x-versionadded: v2.21
        multiseriesIdColumns:
          description: May be used only with time series projects. An array of the
            column names identifying  the series to which each row of the dataset
            belongs. Currently only one multiseries ID column is supported. See the
            :ref:`multiseries <multiseries>` section of the time series documentation
            for more context.
          items:
            type: string
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.11
        numberOfBacktests:
          description: The number of backtests to use. If omitted, defaults to a positive
            value selected by the server based on the validation and gap durations.
          maximum: 20
          minimum: 1
          type: integer
        numberOfDoNotDeriveFeatures:
          description: Number of features that are marked as "do not derive".
          type: integer
          x-versionadded: v2.17
        numberOfKnownInAdvanceFeatures:
          description: Number of features that are marked as "known in advance".
          type: integer
          x-versionadded: v2.14
        partitioningExtendedWarnings:
          description: An array of available warnings about potential problems with
            the chosen partitioning that could cause issues during modeling, although
            the partitioning may be successfully submitted.
          items:
            $ref: '#/components/schemas/PartitioningExtendedWarning'
          type: array
        partitioningWarnings:
          description: An array of available warnings about potential problems with
            the chosen partitioning that could cause issues during modeling, although
            the partitioning may be successfully submitted.
          items:
            $ref: '#/components/schemas/PartitioningWarning'
          type: array
        periodicities:
          description: A list of periodicities for time series projects only. For
            classification problems periodicities are not allowed. If this is provided,
            parameter 'differencing_method' will default to 'seasonal' if not provided
            or 'auto'.
          items:
            $ref: '#/components/schemas/Periodicity'
          nullable: true
          type: array
        primaryTrainingDuration:
          description: The duration of primary training duration for scoring the holdout.
          format: duration
          type: string
        primaryTrainingEndDate:
          description: The end date of primary training data for scoring the holdout.
          format: date-time
          type: string
        primaryTrainingRowCount:
          description: The number of rows in the primary training data for scoring
            the holdout
          type: integer
        primaryTrainingStartDate:
          description: The start date of primary training data for scoring the holdout.
          format: date-time
          type: string
        projectId:
          description: The ID of the project.
          type: string
        totalRowCount:
          description: The total number of rows in the project dataset
          type: integer
        treatAsExponential:
          description: For time series projects only. Used to specify whether to treat
            data as exponential trend and apply transformations like log-transform.
            For classification problems `always` is not allowed. Defaults to `auto`.
          enum:
          - auto
          - never
          - always
          nullable: true
          type: string
          x-versionadded: v2.9
        unsupervisedMode:
          description: A boolean value indicating whether an unsupervised project
            should be created.
          nullable: true
          type: boolean
          x-versionadded: v2.31
        unsupervisedType:
          description: The type of unsupervised project.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.31
        useCrossSeriesFeatures:
          description: For multiseries projects only. Indicating whether to use cross-series
            features.
          nullable: true
          type: boolean
          x-versionadded: v2.14
        useTimeSeries:
          description: A boolean value indicating whether a time series project should
            be created instead of a regular project which uses datetime partitioning.
          type: boolean
          x-versionadded: v2.8
        validationDuration:
          description: The default validation duration for all backtests. If the primary
            date/time feature in a time series project is irregular, you cannot set
            a default validation length. Instead, set each duration individually.
          format: duration
          nullable: true
          type: string
        windowsBasisUnit:
          description: For time series projects only. Indicates which unit is basis
            for feature derivation window and forecast window. Valid options are detected
            time unit or `ROW`. If omitted, the default value is detected time unit.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          nullable: true
          type: string
          x-versionadded: v2.14
      required:
      - aggregationType
      - autopilotDataSamplingMethod
      - autopilotDataSelectionMethod
      - availableHoldoutEndDate
      - availableTrainingDuration
      - availableTrainingEndDate
      - availableTrainingRowCount
      - availableTrainingStartDate
      - backtests
      - calendarId
      - calendarName
      - crossSeriesGroupByColumns
      - dateFormat
      - datetimePartitionColumn
      - defaultToAPriori
      - defaultToDoNotDerive
      - defaultToKnownInAdvance
      - differencingMethod
      - disableHoldout
      - featureDerivationWindowEnd
      - featureDerivationWindowStart
      - featureSettings
      - forecastWindowEnd
      - forecastWindowStart
      - gapDuration
      - gapEndDate
      - gapRowCount
      - gapStartDate
      - holdoutDuration
      - holdoutEndDate
      - holdoutRowCount
      - holdoutStartDate
      - modelSplits
      - multiseriesIdColumns
      - numberOfBacktests
      - numberOfDoNotDeriveFeatures
      - numberOfKnownInAdvanceFeatures
      - partitioningWarnings
      - periodicities
      - primaryTrainingDuration
      - primaryTrainingEndDate
      - primaryTrainingRowCount
      - primaryTrainingStartDate
      - projectId
      - totalRowCount
      - treatAsExponential
      - useCrossSeriesFeatures
      - useTimeSeries
      - validationDuration
      - windowsBasisUnit
      type: object
    Float:
      properties:
        max:
          description: Maximum value for the parameter.
          type: number
        min:
          description: Minimum value for the parameter.
          type: number
        supportsGridSearch:
          description: When True, Grid Search is supported for this parameter.
          type: boolean
      required:
      - max
      - min
      - supportsGridSearch
      type: object
    FloatList:
      properties:
        maxLength:
          description: Maximum permitted length of the list.
          minimum: 0
          type: integer
        maxVal:
          description: Maximum permitted value.
          type: number
        minLength:
          description: Minimum permitted length of the list.
          minimum: 0
          type: integer
        minVal:
          description: Minimum permitted value.
          type: number
        supportsGridSearch:
          description: When True, Grid Search is supported for this parameter.
          type: boolean
      required:
      - maxLength
      - maxVal
      - minLength
      - minVal
      - supportsGridSearch
      type: object
    ForecastDate:
      properties:
        columnName:
          description: The column name in prediction datasets to be used as forecast
            date
          nullable: true
          type: string
        datetimeFormat:
          description: The datetime format of the forecast date column in prediction
            datasets.
          nullable: true
          type: string
        enabled:
          description: Indicates whether predictions by forecast dates is enabled
            for the deployment.
          type: boolean
      required:
      - enabled
      type: object
    ForecastDistancePlotDataEntryResponse:
      properties:
        backtestingScore:
          description: Backtesting score for this forecast distance. If backtesting
            has not been run for this model, this score will be `null`.
          nullable: true
          type: number
        forecastDistance:
          description: The number of time units the scored rows are away from the
            forecast point.
          type: integer
        holdoutScore:
          description: Holdout set score for this forecast distance. If holdout is
            locked for the project, this score will be `null`.
          nullable: true
          type: number
        validationScore:
          description: Validation set score for this forecast distance.
          type: number
      required:
      - backtestingScore
      - forecastDistance
      - holdoutScore
      - validationScore
      type: object
    ForecastDistanceStabilityPlotResponse:
      properties:
        endDate:
          description: ISO-formatted start date of the project dataset.
          format: date-time
          type: string
        forecastDistancePlotData:
          description: An array of objects containing the details of the scores for
            each forecast distance.
          items:
            $ref: '#/components/schemas/ForecastDistancePlotDataEntryResponse'
          type: array
        metricName:
          description: Name of the metric used to compute the scores.
          type: string
        startDate:
          description: ISO-formatted start date of the project dataset.
          format: date-time
          type: string
      required:
      - endDate
      - forecastDistancePlotData
      - metricName
      - startDate
      type: object
    ForecastVsActualPlotsBins:
      properties:
        actual:
          description: Average actual value of the target in the bin. `null` if there
            are no entries in the bin.
          nullable: true
          type: number
        endDate:
          description: 'The datetime of the end of the bin (exclusive). '
          format: date-time
          type: string
        error:
          description: Average absolute residual value of the bin. `null` if there
            are no entries in the bin.
          minimum: 0
          nullable: true
          type: number
        forecasts:
          description: An array of average forecasts for the model for each forecast
            distance. Empty if there are no forecasts in the bin. Each index in the
            `forecasts` array maps to `forecastDistances` array index.
          items:
            type: number
          maxItems: 100
          type: array
        frequency:
          description: Indicates number of values averaged in bin in case of a resolution
            change.
          nullable: true
          type: integer
        normalizedError:
          description: Normalized average absolute residual value of the bin. `null`
            if there are no entries in the bin.
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        startDate:
          description: 'The datetime of the start of the bin (inclusive). '
          format: date-time
          type: string
      required:
      - actual
      - endDate
      - error
      - forecasts
      - frequency
      - normalizedError
      - startDate
      type: object
    ForecastVsActualPlotsDataResponse:
      properties:
        bins:
          description: An array of bins for the retrieved plots.
          items:
            $ref: '#/components/schemas/ForecastVsActualPlotsBins'
          maxItems: 1000
          minItems: 1
          type: array
        calendarEvents:
          description: An array of calendar events for a retrieved plot.
          items:
            $ref: '#/components/schemas/CalendarEvent'
          maxItems: 1000
          type: array
        endDate:
          description: 'The datetime of the end of the chart data (exclusive). '
          format: date-time
          type: string
        forecastDistances:
          description: An array of forecast distances. Forecast distance specifies
            the number of time steps between the predicted point and the origin point.
          items:
            maximum: 1000
            minimum: 1
            type: integer
          maxItems: 100
          minItems: 1
          type: array
        resolution:
          description: The resolution that is used for binning.
          enum:
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
        startDate:
          description: 'The datetime of the start of the chart data (inclusive). '
          format: date-time
          type: string
      required:
      - bins
      - calendarEvents
      - endDate
      - forecastDistances
      - resolution
      - startDate
      type: object
    ForecastVsActualPlotsForecastDistancesStatus:
      properties:
        completed:
          description: An array of available forecast distances for the `completed`
            status. If there are no forecast distances for this status, it will not
            appear in the response.
          items:
            maximum: 1000
            minimum: 1
            type: integer
          maxItems: 1000
          minItems: 1
          type: array
        errored:
          description: An array of available forecast distances for the `errored`
            status. If there are no forecast distances for this status, it will not
            appear in the response.
          items:
            maximum: 1000
            minimum: 1
            type: integer
          maxItems: 1000
          minItems: 1
          type: array
        inProgress:
          description: An array of available forecast distances for the `inProgress`
            status. If there are no forecast distances for this status, it will not
            appear in the response.
          items:
            maximum: 1000
            minimum: 1
            type: integer
          maxItems: 1000
          minItems: 1
          type: array
        insufficientData:
          description: An array of available forecast distances for the `insufficientData`
            status. If there are no forecast distances for this status, it will not
            appear in the response.
          items:
            maximum: 1000
            minimum: 1
            type: integer
          maxItems: 1000
          minItems: 1
          type: array
        notCompleted:
          description: An array of available forecast distances for the `notCompleted`
            status. If there are no forecast distances for this status, it will not
            appear in the response.
          items:
            maximum: 1000
            minimum: 1
            type: integer
          maxItems: 1000
          minItems: 1
          type: array
      type: object
    ForecastVsActualPlotsMetadataResponse:
      properties:
        backtestMetadata:
          description: An array of metadata information for each backtest. The array
            index of metadata object is the backtest index.
          items:
            $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
          maxItems: 20
          minItems: 1
          type: array
        backtestStatuses:
          description: An array of status information for each backtest. The array
            index of status object is the backtest index.
          items:
            $ref: '#/components/schemas/ForecastVsActualPlotsStatus'
          maxItems: 20
          minItems: 1
          type: array
        estimatedSeriesLimit:
          description: Estimated number of series that can be calculated in one request
            for 1 FD.
          minimum: 1
          type: integer
        holdoutMetadata:
          $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
          description: Metadata information for holdout.
        holdoutStatuses:
          $ref: '#/components/schemas/ForecastVsActualPlotsStatus'
          description: Status information for holdout.
        resolutions:
          description: An array of available time resolutions for which plots can
            be retrieved.
          items:
            enum:
            - milliseconds
            - seconds
            - minutes
            - hours
            - days
            - weeks
            - months
            - quarters
            - years
            type: string
          maxItems: 9
          minItems: 1
          type: array
      required:
      - backtestMetadata
      - backtestStatuses
      - holdoutMetadata
      - holdoutStatuses
      - resolutions
      type: object
    ForecastVsActualPlotsStatus:
      properties:
        training:
          $ref: '#/components/schemas/ForecastVsActualPlotsForecastDistancesStatus'
          description: Status for backtest/holdout training.
        validation:
          $ref: '#/components/schemas/ForecastVsActualPlotsForecastDistancesStatus'
          description: Status for backtest/holdout validation.
      required:
      - training
      - validation
      type: object
    FormattedSummary:
      properties:
        enrichmentRate:
          $ref: '#/components/schemas/Warnings'
          description: Warning about the enrichment rate
        mostRecentData:
          $ref: '#/components/schemas/Warnings'
          description: Warning about the most recent data
        windowSettings:
          $ref: '#/components/schemas/Warnings'
          description: Warning about the feature derivation window settings
      required:
      - enrichmentRate
      type: object
    FrequentValueData:
      properties:
        count:
          description: Count of specified frequent value in the sample, weighted by
            exposure or weights
          type: integer
        dataQuality:
          description: Any data quality issue associated with this particularvalue
            of the feature. Possible data quality types include 'excess_zero', 'inlier',
            'disguised_missing_value', and 'no_issues_found' and the relevant statistics.
          type: string
        target:
          description: Average target value for the specified frequent value if the
            target is binary or numeric. With weights or exposure, this becomes a
            weighted average. If the target is not set, it returns None.
          nullable: true
          type: number
        value:
          anyOf:
          - type: number
          - type: string
          description: Specified frequent value, either a float or a string, like
            `=All Others+`
      required:
      - count
      - dataQuality
      - target
      - value
      type: object
    FrequentValuesResponse:
      properties:
        frequentValues:
          description: List of frequent value and data quality information
          items:
            $ref: '#/components/schemas/FrequentValueData'
          type: array
        name:
          description: Name of the feature
          type: string
        numRows:
          description: Number of rows in the sample used to determine frequent values
          type: integer
        projectId:
          description: Project Id
          type: string
      required:
      - frequentValues
      - name
      - numRows
      - projectId
      type: object
    FromLatest:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          x-versionadded: v2.23
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
          type: string
          x-versionadded: v2.19
        credentials:
          description: A list of credentials to use if this is a Spark dataset that
            requires credentials.
          type: string
          x-versionadded: v2.20
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server-side HTTP request and never saved
            or stored. Required only if the previous data source was a data source.
            DEPRECATED: please use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
        useKerberos:
          default: false
          description: If true, use Kerberos for database authentication.
          type: boolean
          x-versionadded: v2.19
        useLatestSuccess:
          default: false
          description: If true, use the latest version that was successfully ingested
            instead of the latest version, which might be in an errored state. If
            no successful version is present, the latest errored version is used and
            the operation fails.
          type: boolean
          x-versionadded: v2.20
        user:
          description: 'The username for database authentication. Required only if
            the dataset was initially created from a data source. DEPRECATED: please
            use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
      type: object
    FromSpecific:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          x-versionadded: v2.23
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
          type: string
        credentials:
          description: A list of credentials to use if this is a Spark dataset that
            requires credentials.
          type: string
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server-side HTTP request and never saved
            or stored. Required only if the previous data source was a data source.
            DEPRECATED: please use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
        useKerberos:
          default: false
          description: If true, use Kerberos for database authentication.
          type: boolean
        user:
          description: 'The username for database authentication. Required only if
            the dataset was initially created from a data source. DEPRECATED: please
            use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
      type: object
    FrozenModelCreate:
      properties:
        modelId:
          description: the ID of an existing model to use as a source of training
            parameters.
          type: string
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          maximum: 100
          minimum: 2
          type: integer
          x-versionadded: v2.27
        samplePct:
          description: the percentage of the dataset to use with the model. Only one
            of `samplePct` and `trainingRowCount` should be specified. The specified
            percentage should be between 0.0 and 100.0.
          type: number
        trainingRowCount:
          description: the integer number of rows of the dataset to use with the model.
            Only one of `samplePct` and `trainingRowCount` should be specified.
          type: integer
      required:
      - modelId
      type: object
    FrozenModelListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of the frozen models in a project.
          items:
            $ref: '#/components/schemas/ModelDetailsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          nullable: true
          type: string
        totalCount:
          description: Total number of records.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      type: object
    FullDatasetDetailsResponse:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          items:
            description: The dataset category.
            enum:
            - BATCH_PREDICTIONS
            - CUSTOM_MODEL_TESTING
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          type: array
        columnCount:
          description: The number of columns in the dataset.
          type: integer
          x-versionadded: v2.30
        createdBy:
          description: Username of the user who created the dataset.
          nullable: true
          type: string
        creationDate:
          description: The date when the dataset was created.
          format: date-time
          type: string
        dataEngineQueryId:
          description: ID of the source data engine query.
          nullable: true
          type: string
        dataPersisted:
          description: If true, user is allowed to view extended data profile (which
            includes data statistics like min/max/median/mean, histogram, etc.) and
            download data. If false, download is not allowed and only the data schema
            (feature names and types) will be available.
          type: boolean
        dataSourceId:
          description: ID of the datasource used as the source of the dataset.
          nullable: true
          type: string
        dataSourceType:
          description: The type of the datasource that was used as the source of the
            dataset.
          type: string
        datasetId:
          description: The ID of this dataset.
          type: string
        datasetSize:
          description: The size of the dataset as a CSV in bytes.
          type: integer
          x-versionadded: v2.21
        description:
          description: The description of the dataset.
          nullable: true
          type: string
        eda1ModificationDate:
          description: The ISO 8601 formatted date and time when the EDA1 for the
            dataset was updated.
          format: date-time
          type: string
        eda1ModifierFullName:
          description: The user who was the last to update EDA1 for the dataset.
          type: string
        entityCountByType:
          $ref: '#/components/schemas/EntityCountByTypeResponse'
          description: Number of different type entities that use the dataset.
        error:
          description: Details of exception raised during ingestion process, if any.
          type: string
        featureCount:
          description: Total number of features in the dataset.
          type: integer
        featureCountByType:
          description: Number of features in the dataset grouped by feature type.
          items:
            $ref: '#/components/schemas/FeatureCountByTypeResponse'
          type: array
        isDataEngineEligible:
          description: Whether this dataset can be a data source of a data engine
            query.
          type: boolean
          x-versionadded: v2.20
        isLatestVersion:
          description: Whether this dataset version is the latest version of this
            dataset.
          type: boolean
        isSnapshot:
          description: Whether the dataset is an immutable snapshot of data which
            has previously been retrieved and saved to DataRobot.
          type: boolean
        isWranglingEligible:
          description: Whether the source of the dataset can support wrangling.
          type: boolean
          x-versionadded: 2.30.0
        lastModificationDate:
          description: The ISO 8601 formatted date and time when the dataset was last
            modified.
          format: date-time
          type: string
        lastModifierFullName:
          description: Full name of user who was the last to modify the dataset.
          type: string
        name:
          description: The name of this dataset in the catalog.
          type: string
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
          x-versionadded: v2.21
        recipeId:
          description: ID of the source recipe.
          nullable: true
          type: string
        rowCount:
          description: The number of rows in the dataset.
          type: integer
          x-versionadded: v2.21
        sampleSize:
          $ref: '#/components/schemas/SampleSize'
          description: Ingest size to use during dataset registration. Default behavior
            is to ingest full dataset.
          nullable: true
          x-versionadded: v2.27
        tags:
          description: List of tags attached to the item.
          items:
            type: string
          type: array
        timeSeriesProperties:
          $ref: '#/components/schemas/TimeSeriesProperties'
          description: Properties related to time series data prep.
          x-versionadded: v2.26
        uri:
          description: The URI to datasource. For example, `file_name.csv`, or `jdbc:DATA_SOURCE_GIVEN_NAME/SCHEMA.TABLE_NAME`,
            or `jdbc:DATA_SOURCE_GIVEN_NAME/<query>` for `query` based datasources,
            or`https://s3.amazonaws.com/datarobot_test/kickcars-sample-200.csv`, etc.
          type: string
        versionId:
          description: The object ID of the catalog_version the dataset belongs to.
          type: string
      required:
      - categories
      - columnCount
      - createdBy
      - creationDate
      - dataEngineQueryId
      - dataPersisted
      - dataSourceId
      - dataSourceType
      - datasetId
      - datasetSize
      - description
      - eda1ModificationDate
      - eda1ModifierFullName
      - error
      - featureCount
      - featureCountByType
      - isDataEngineEligible
      - isLatestVersion
      - isSnapshot
      - isWranglingEligible
      - lastModificationDate
      - lastModifierFullName
      - name
      - processingState
      - recipeId
      - rowCount
      - tags
      - timeSeriesProperties
      - uri
      - versionId
      type: object
    GCPDataStreamer:
      properties:
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: Use the specified credential to access the url
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        type:
          description: Type name for this intake type
          enum:
          - gcp
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    GCPIntake:
      properties:
        credentialId:
          description: Use the specified credential to access the url
          nullable: true
          type: string
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        type:
          description: Type name for this intake type
          enum:
          - gcp
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    GCPKey:
      properties:
        authProviderX509CertUrl:
          description: Auth provider X509 certificate URL.
          format: uri
          type: string
        authUri:
          description: Auth URI.
          format: uri
          type: string
        clientEmail:
          description: Client email address.
          type: string
        clientId:
          description: Client ID.
          type: string
        clientX509CertUrl:
          description: Client X509 certificate URL.
          format: uri
          type: string
        privateKey:
          description: Private key.
          type: string
        privateKeyId:
          description: Private key ID
          type: string
        projectId:
          description: Project ID.
          type: string
        tokenUri:
          description: Token URI.
          format: uri
          type: string
        type:
          description: GCP account type.
          enum:
          - service_account
          type: string
      required:
      - type
      type: object
    GCPOutput:
      properties:
        credentialId:
          description: Use the specified credential to access the url
          nullable: true
          type: string
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        partitionColumns:
          description: For Parquet directory-scoring only. The column names of the
            intake data of which to partition the dataset. Columns are partitioned
            in the order they are given. At least one value is required if scoring
            to a directory (meaning the output url ends with a slash ("/").
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.26
        type:
          description: Type name for this output type
          enum:
          - gcp
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    GCPOutputAdaptor:
      properties:
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: Use the specified credential to access the url
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        partitionColumns:
          description: For Parquet directory-scoring only. The column names of the
            intake data of which to partition the dataset. Columns are partitioned
            in the order they are given. At least one value is required if scoring
            to a directory (meaning the output url ends with a slash ("/").
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.26
        type:
          description: Type name for this output type
          enum:
          - gcp
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    GeneratedMetadata:
      properties:
        outputColumns:
          description: A list of column lists that are associated with the output
            datasets from the custom model conversion process.
          items:
            description: A columns list belong to a single dataset output from a custom
              model conversion process
            items:
              description: A column name belong to a single dataset output from a
                custom model conversion process
              maxLength: 1024
              minLength: 1
              type: string
            maxItems: 50
            minItems: 1
            type: array
          type: array
        outputDatasets:
          description: A list of output datasets from the custom model conversion
            process.
          items:
            description: An output dataset name from the custom model conversion process
            type: string
          maxItems: 50
          minItems: 1
          type: array
      required:
      - outputColumns
      - outputDatasets
      type: object
    GeneratorSettings:
      properties:
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column
            in time series project.
          type: string
        defaultCategoricalAggregationMethod:
          description: Default aggregation method used for categorical feature.
          enum:
          - last
          - mostFrequent
          type: string
        defaultNumericAggregationMethod:
          description: Default aggregation method used for numeric feature.
          enum:
          - mean
          - sum
          type: string
        defaultTextAggregationMethod:
          description: Default aggregation method used for text feature.
          enum:
          - concat
          - last
          - meanLength
          - mostFrequent
          - totalLength
          type: string
        endToSeriesMaxDatetime:
          default: true
          description: A boolean value indicating whether generates post-aggregated
            series up to series maximum datetime or global maximum datetime.
          type: boolean
        multiseriesIdColumns:
          description: An array with the names of columns identifying the series to
            which row of the output dataset belongs. Currently, only one multiseries
            ID column is supported.
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        startFromSeriesMinDatetime:
          default: true
          description: A boolean value indicating whether post-aggregated series starts
            from series minimum datetime or global minimum datetime.
          type: boolean
        target:
          description: The name of target for the output dataset.
          type: string
        timeStep:
          description: Number of time steps for the output dataset.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        timeUnit:
          description: Indicates which unit is a basis for time steps of the output
            dataset.
          enum:
          - DAY
          - HOUR
          - MINUTE
          - MONTH
          - QUARTER
          - WEEK
          - YEAR
          type: string
      required:
      - datetimePartitionColumn
      - defaultCategoricalAggregationMethod
      - defaultNumericAggregationMethod
      - timeStep
      - timeUnit
      type: object
    GenericRecipeFromDataset:
      discriminator:
        propertyName: status
      oneOf:
      - properties:
          datasetId:
            description: Dataset ID to create a Recipe from.
            type: string
          dialect:
            description: Source type data was retrieved from. Should be omitted for
              dataset rewrangling.
            enum:
            - snowflake
            - bigquery
            - databricks
            - spark
            type: string
          status:
            description: Preview recipe
            enum:
            - preview
            type: string
        required:
        - datasetId
        - dialect
        - status
        type: object
      - properties:
          datasetId:
            description: Dataset ID to create a Recipe from.
            type: string
          datasetVersionId:
            default: null
            description: Dataset version ID to create a Recipe from.
            nullable: true
            type: string
          dialect:
            description: Source type data was retrieved from. Should be omitted for
              dataset rewrangling and feature discovery recipes.
            enum:
            - snowflake
            - bigquery
            - databricks
            - spark
            type: string
          experimentContainerId:
            description: '[DEPRECATED - replaced with use_case_id] ID assigned to
              the Use Case, which is an experimental container for the recipe.'
            type: string
          inputs:
            description: List of recipe inputs. Should be omitted on dataset wrangling
              when dataset is created from recipe.
            items:
              $ref: '#/components/schemas/DatasetInputCreate'
              description: Dataset configuration.
            maxItems: 1
            minItems: 1
            type: array
          recipeType:
            default: WRANGLING
            description: Type of the recipe workflow.
            enum:
            - wrangling
            - Wrangling
            - WRANGLING
            - featureDiscovery
            - FeatureDiscovery
            - FEATURE_DISCOVERY
            - featureDiscoveryPrivatePreview
            - FeatureDiscoveryPrivatePreview
            - FEATURE_DISCOVERY_PRIVATE_PREVIEW
            type: string
          status:
            default: draft
            description: Wrangling recipe
            enum:
            - draft
            type: string
          useCaseId:
            description: ID of the Use Case associated with the recipe.
            type: string
            x-versionadded: v2.33
        required:
        - datasetId
        - recipeType
        type: object
    GeoFeaturePlotData:
      properties:
        aggregation:
          description: Type of geo aggregation.
          enum:
          - grid
          - unique
          type: string
        bbox:
          description: Bounding box of feature map.
          type: object
        features:
          description: Location features over map
          items:
            $ref: '#/components/schemas/GeoFeaturePlotFeature'
          type: array
        summary:
          $ref: '#/components/schemas/GeoFeaturePlotSummary'
          description: Summary of feature map.
        type:
          description: GeoJSON FeatureCollection.
          type: string
        valueAggregation:
          description: Type of feature aggregation.
          enum:
          - geometry
          type: string
      required:
      - aggregation
      - bbox
      - features
      - summary
      - type
      - valueAggregation
      type: object
    GeoFeaturePlotFeature:
      properties:
        geometry:
          $ref: '#/components/schemas/GeoJSON'
          description: Geometry.
        properties:
          $ref: '#/components/schemas/GeoFeaturePlotFeatureProperties'
          description: Properties of location features.
        type:
          description: With a fixed value of 'Feature'.
          type: string
      required:
      - geometry
      - properties
      - type
      type: object
    GeoFeaturePlotFeatureProperties:
      properties:
        count:
          description: Total num of samples located within this geometry.
          type: integer
      required:
      - count
      type: object
    GeoFeaturePlotSummary:
      properties:
        maxCount:
          description: Max num of samples located within one geometry.
          type: integer
        minCount:
          description: Min num of samples located within one geometry.
          type: integer
        totalCount:
          description: Total num of samples across all geometry objects.
          type: integer
      required:
      - maxCount
      - minCount
      - totalCount
      type: object
    GeoJSON:
      properties:
        coordinates:
          description: Coordinate representative of a geometry.
          items:
            type: object
          type: array
        type:
          description: Type of geometry.
          enum:
          - Point
          - LineString
          - Polygon
          type: string
      required:
      - coordinates
      - type
      type: object
    GeometryFeaturePLotCreatePayload:
      properties:
        feature:
          description: Name of a location feature from the dataset to plot on map.
          type: string
      required:
      - feature
      type: object
    GeometryFeaturePlotRetrieveResponse:
      properties:
        feature:
          description: Name of location feature to plot on map.
          type: string
        plotData:
          $ref: '#/components/schemas/GeoFeaturePlotData'
          description: Geo feature plot data
        projectId:
          description: The project to select a location feature from.
          type: string
      required:
      - feature
      - plotData
      - projectId
      type: object
    GeospatialFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          nullable: true
          type: number
        featureName:
          description: Feature name.
          type: string
        featureType:
          description: Feature type.
          enum:
          - geospatialPoint
          type: string
        insights:
          description: A list of Cluster Insights for a geospatial centroid or point
            feature.
          items:
            $ref: '#/components/schemas/GeospatialInsights'
          type: array
      required:
      - featureName
      - featureType
      - insights
      type: object
    GeospatialInsights:
      properties:
        insightName:
          description: Insight name.
          enum:
          - representativeLocations
          type: string
        perCluster:
          description: Statistic for different feature values in this cluster.
          items:
            $ref: '#/components/schemas/PerClusterGeospatial'
          type: array
      required:
      - insightName
      - perCluster
      type: object
    GetDatasetVersionProjectsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Array of project references.
          items:
            $ref: '#/components/schemas/DatasetProject'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    GitModelVersion:
      properties:
        commitUrl:
          description: A URL to the commit page in GitHub repository.
          format: uri
          type: string
        mainBranchCommitSha:
          description: Specifies the commit SHA-1 in GitHub repository from the main
            branch that corresponds to a given custom model version.
          maxLength: 40
          minLength: 40
          type: string
        pullRequestCommitSha:
          default: null
          description: Specifies the commit SHA-1 in GitHub repository from the main
            branch that corresponds to a given custom model version.
          maxLength: 40
          minLength: 40
          nullable: true
          type: string
        refName:
          description: The branch or tag name that triggered the workflow run. For
            workflows triggered by push, this is the branch or tag ref that was pushed.
            For workflows triggered by pull_request, this is the pull request merge
            branch.
          type: string
      required:
      - commitUrl
      - mainBranchCommitSha
      - pullRequestCommitSha
      - refName
      type: object
    GlobalMetrics:
      properties:
        f1:
          description: Average F1 score
          type: number
        precision:
          description: Average precision score
          type: number
        recall:
          description: Avergae recall score
          type: number
      required:
      - f1
      - precision
      - recall
      type: object
    GoogleServiceAccountCredentials:
      properties:
        configId:
          description: ID of Secure configurations shared by admin.Alternative to
            googleConfigId (deprecated). If specified, cannot include gcpKey.
          type: string
        credentialType:
          description: The type of these credentials, 'gcp' here.
          enum:
          - gcp
          type: string
        gcpKey:
          $ref: '#/components/schemas/GCPKey'
          description: The Google Cloud Platform (GCP) key. Output is the downloaded
            JSON resulting from creating a service account *User Managed Key*  (in
            the *IAM & admin > Service accounts section* of GCP).Required if googleConfigId/configId
            is not specified.Cannot include this parameter if googleConfigId/configId
            is specified.
        googleConfigId:
          description: ID of Secure configurations shared by admin. This is deprecated.Please
            use configId instead. If specified, cannot include gcpKey.
          type: string
      required:
      - credentialType
      type: object
    GrantAccessControlWithId:
      properties:
        id:
          description: The ID of the recipient.
          type: string
        role:
          description: The role of the recipient on this entity. One of OWNER, USER,
            OBSERVER.
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    GrantAccessControlWithIdWithGrant:
      properties:
        canShare:
          default: true
          description: Whether the org/group/user should be able to share with others.If
            true, the org/group/user will be able to grant any role up to and includingtheir
            own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored.
          type: boolean
        id:
          description: The ID of the recipient.
          type: string
        role:
          description: The role of the recipient on this entity. One of OWNER, USER,
            OBSERVER.
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    GrantAccessControlWithUsername:
      properties:
        role:
          description: The role of the recipient on this entity. One of OWNER, USER,
            OBSERVER.
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          type: string
        username:
          description: Username of the user to update the access role for.
          type: string
      required:
      - role
      - shareRecipientType
      - username
      type: object
    GrantAccessControlWithUsernameWithGrant:
      properties:
        canShare:
          default: true
          description: Whether the org/group/user should be able to share with others.If
            true, the org/group/user will be able to grant any role up to and includingtheir
            own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored.
          type: boolean
        role:
          description: The role of the recipient on this entity. One of OWNER, USER,
            OBSERVER.
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          type: string
        username:
          description: Username of the user to update the access role for.
          type: string
      required:
      - role
      - shareRecipientType
      - username
      type: object
    HTTPDataStreamer:
      properties:
        type:
          description: Type name for this intake type
          enum:
          - http
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    HTTPIntake:
      properties:
        type:
          description: Type name for this intake type
          enum:
          - http
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    HTTPOutput:
      properties:
        headers:
          description: Extra headers to send with the request
          type: object
        method:
          description: Method to use when saving the CSV file
          enum:
          - POST
          - PUT
          type: string
        type:
          description: Type name for this output type
          enum:
          - http
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - method
      - type
      - url
      type: object
    Hdfs:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        doSnapshot:
          default: true
          description: If true, create a snapshot dataset; if false, create a remote
            dataset. Creating snapshots from non-file sources requires an additional
            permission, `Enable Create Snapshot Data Source`.
          type: boolean
        namenodeWebhdfsPort:
          description: The port of HDFS name node.
          type: integer
        password:
          description: The password (in cleartext) for authenticating to HDFS using
            Kerberos. The password will be encrypted on the server side in scope of
            HTTP request and never saved or stored.
          type: string
        persistDataAfterIngestion:
          description: If true, will enforce saving all data (for download and sampling)
            and will allow a user to view extended data profile (which includes data
            statistics like min/max/median/mean, histogram, etc.). If false, will
            not enforce saving data. The data schema (feature names and types) still
            will be available. Specifying this parameter to false and `doSnapshot`
            to true will result in an error
          type: boolean
        url:
          description: The HDFS url to use as the source of data for the dataset being
            created.
          format: uri
          type: string
        user:
          description: The username for authenticating to HDFS using Kerberos.
          type: string
      required:
      - url
      type: object
    HdfsProjectCreate:
      properties:
        password:
          description: Password for authenticating to HDFS using Kerberos. The password
            will be encrypted on the server side in scope of HTTP request and never
            saved or stored.
          type: string
        port:
          description: Port of the WebHDFS Namenode server. If not specified, defaults
            to HDFS default port 50070.
          type: integer
        projectName:
          description: Name of the project to be created. If not specified, project
            name will be based on the file name.
          type: string
        url:
          description: URL of the WebHDFS resource. Represent the file using the `hdfs://`
            protocol marker (for example,  `hdfs:///tmp/somedataset.csv`).
          format: uri
          type: string
        user:
          description: Username for authenticating to HDFS using Kerberos
          type: string
      required:
      - url
      type: object
    HealthSettings:
      properties:
        accuracy:
          $ref: '#/components/schemas/AccuracyHealth'
          description: Accuracy health status setting.
          x-versionadded: v2.33
        actualsTimeliness:
          $ref: '#/components/schemas/TimelinessSettings'
          description: Actuals timeliness health setting.
          x-versionadded: v2.33
        customMetrics:
          $ref: '#/components/schemas/CustomMetricsHealth'
          description: Custom metrics health status setting.
          x-versionadded: v2.33
        dataDrift:
          $ref: '#/components/schemas/DataDriftHealth'
          description: Data drift health status setting.
          x-versionadded: v2.33
        fairness:
          $ref: '#/components/schemas/FairnessHealth'
          description: Fairness health status setting. Only available if deployment
            supports fairness.
          x-versionadded: v2.33
        predictionsTimeliness:
          $ref: '#/components/schemas/TimelinessSettings'
          description: Predictions timeliness health setting.
          x-versionadded: v2.33
        service:
          $ref: '#/components/schemas/ServiceHealth'
          description: Service health status setting.
          x-versionadded: v2.33
      type: object
    Histogram:
      properties:
        intervalEnd:
          description: The end of the interval.
          type: number
        intervalStart:
          description: The start of the interval.
          type: number
        occurrences:
          description: The number of times the predicted value fits within that interval.
          type: integer
      required:
      - intervalEnd
      - intervalStart
      - occurrences
      type: object
    HistogramBarsDetails:
      properties:
        label:
          description: Name of the class.
          type: string
        value:
          description: Ratio of occurrence of the class.
          type: number
      required:
      - label
      - value
      type: object
    HistogramDetails:
      properties:
        bars:
          description: Class details for the histogram chart
          items:
            $ref: '#/components/schemas/HistogramBarsDetails'
          type: array
        bin:
          anyOf:
          - type: string
          - type: integer
          description: Label for the bin grouping
      required:
      - bars
      - bin
      type: object
    HoldoutDataResponse:
      properties:
        datasetId:
          description: 'The ID of the dataset.                Should be provided only
            for unstructured models.                 '
          nullable: true
          type: string
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          nullable: true
          type: string
        datasetVersionId:
          description: 'The ID of the dataset version.                Should be provided
            only for unstructured models.                 '
          nullable: true
          type: string
        partitionColumn:
          description: The name of the column containing the partition assignments.
          maxLength: 500
          nullable: true
          type: string
      type: object
    HttpOutputAdaptor:
      properties:
        headers:
          description: Extra headers to send with the request
          type: object
        method:
          description: Method to use when saving the CSV file
          enum:
          - POST
          - PUT
          type: string
        type:
          description: Type name for this output type
          enum:
          - http
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - method
      - type
      - url
      type: object
    Humility:
      properties:
        enabled:
          description: Indicates whether humility rules are enabled for the deployment.
          type: boolean
      required:
      - enabled
      type: object
    HumilityStatsBucket:
      properties:
        period:
          $ref: '#/components/schemas/TimeRange'
          description: An object with the keys "start" and "end" defining the period.
        values:
          description: Rules response objects.
          items:
            $ref: '#/components/schemas/HumilityStatsRule'
          type: array
      required:
      - period
      - values
      type: object
    HumilityStatsOverTimeResponse:
      properties:
        buckets:
          description: An array of `bucket` objects, representing service health stats
            of the deployment over time
          items:
            $ref: '#/components/schemas/HumilityStatsBucket'
          type: array
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/HumilityStatsBucket'
          description: A `bucket` object covering whole `start`/`end` time range
      required:
      - buckets
      - summary
      type: object
    HumilityStatsResponse:
      properties:
        data:
          description: metrics rules
          items:
            $ref: '#/components/schemas/HumilityStatsRule'
          type: array
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: An object with the keys "start" and "end" defining the period.
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - data
      - period
      type: object
    HumilityStatsRule:
      properties:
        ruleId:
          description: Id of the humility rule.
          type: string
        ruleName:
          description: Name of the rule.
          type: string
        value:
          description: Number of times the rule was triggered.
          type: integer
      required:
      - ruleId
      - ruleName
      - value
      type: object
    HyperparametersResponse:
      properties:
        buildingBlocks:
          description: Mathematical operators and other components that comprise Eureqa
            Expressions.
          nullable: true
          type: object
        errorMetric:
          description: 'Error Metric Eureqa used internally, to evaluate which models
            to keep on its internal Pareto Front. '
          nullable: true
          type: string
        maxGenerations:
          description: The maximum number of evolutionary generations to run.
          minimum: 32
          nullable: true
          type: integer
        numThreads:
          description: The number of threads Eureqa will run with.
          minimum: 0
          nullable: true
          type: integer
        priorSolutions:
          description: Prior Eureqa Solutions.
          items:
            description: Prior solution.
            type: string
          nullable: true
          type: array
        randomSeed:
          description: Constant to seed Eureqa's pseudo-random number generator.
          minimum: 0
          nullable: true
          type: integer
        splitMode:
          description: Whether to perform in-order (2) or random (1) splitting within
            the training set, for evolutionary re-training and re-validatoon.
          enum:
          - custom
          - '1'
          - '2'
          nullable: true
          type: string
        syncMigrations:
          description: Whether Eureqa's migrations are synchronized.
          nullable: true
          type: boolean
        targetExpressionFormat:
          description: Constrain the target expression to the specified format.
          enum:
          - None
          - exponential
          - featureInteraction
          nullable: true
          type: string
        targetExpressionString:
          description: Eureqa Expression to constrain the form of the models that
            Eureqa will consider.
          nullable: true
          type: string
        timeoutSec:
          description: The duration of time to run the Eureqa search algorithm for
            Eureqa will run until either of max_generations or timeout_sec is reached.
          minimum: 0
          nullable: true
          type: number
        trainingFraction:
          description: The fraction of the DataRobot training data to use for Eureqa
            evolutionary training.
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        trainingSplitExpr:
          description: Valid Eureqa Expression to do Eureqa internal training splits.
          nullable: true
          type: string
        validationFraction:
          description: The fraction of the DataRobot training data to use for Eureqa
            evolutionary validation.
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        validationSplitExpr:
          description: Valid Eureqa Expression to do Eureqa internal validation splits.
          nullable: true
          type: string
        weightExpr:
          description: Eureqa Weight Expression.
          nullable: true
          type: string
      required:
      - buildingBlocks
      - maxGenerations
      - numThreads
      - priorSolutions
      - randomSeed
      - splitMode
      - syncMigrations
      - targetExpressionFormat
      - targetExpressionString
      - timeoutSec
      - trainingFraction
      - trainingSplitExpr
      - validationFraction
      - validationSplitExpr
      - weightExpr
      type: object
    ImageAugmentationListCreateResponse:
      properties:
        augmentationListId:
          description: "\n                Id of the newly created augmentation list\
            \ which can be used to:\n                - retrieve the full augmentation\
            \ list details;\n                - retrieve augmentation previews;\n \
            \               - to set the list id of a model in advanced tuning;\n\
            \                - to delete or rename the list.\n            "
          type: string
      required:
      - augmentationListId
      type: object
    ImageAugmentationListPatchParam:
      properties:
        featureName:
          description: The name of the image feature containing the data to be augmented
          type: string
        inUse:
          description: This parameter was deprecated. You can still pass a value,
            but it will be ignored. DataRobot will takes care of the value itself.
          type: boolean
          x-versiondeprecated: 2.30.0
        initialList:
          description: Whether this list will be used during autopilot to perform
            image augmentation
          type: boolean
        name:
          description: The name of the image augmentation list
          type: string
        numberOfNewImages:
          description: Number of new rows to add for each existing row
          minimum: 0
          type: integer
        projectId:
          description: This parameter was deprecated. You can still pass a value,
            but it will be ignored. If you want to move an augmentation list to another
            project you can create a new list in the other project and delete the
            list in this project.
          type: string
          x-versiondeprecated: 2.30.0
        transformationProbability:
          description: Probability that each enabled transformation will be applied
            to an image. This does not apply to Horizontal or Vertical Flip, which
            are set to 50% always.
          maximum: 1
          minimum: 0
          type: number
        transformations:
          description: List of Transformations to possibly apply to each image
          items:
            $ref: '#/components/schemas/Transformation'
          type: array
      type: object
    ImageAugmentationListsCreate:
      properties:
        featureName:
          description: The name of the image feature containing the data to be augmented
          type: string
        inUse:
          default: false
          description: This parameter was deprecated. You can still pass a value,
            but it will be ignored. DataRobot will takes care of the value itself.
          type: boolean
          x-versiondeprecated: 2.30.0
        initialList:
          default: false
          description: Whether this list will be used during autopilot to perform
            image augmentation
          type: boolean
        name:
          description: The name of the image augmentation list
          type: string
        numberOfNewImages:
          description: Number of new rows to add for each existing row
          minimum: 1
          type: integer
        projectId:
          description: The project containing the image data to be augmented
          type: string
        samplesId:
          default: null
          description: Image Augmentation list samples ID
          nullable: true
          type: string
        transformationProbability:
          description: Probability that each enabled transformation will be applied
            to an image. This does not apply to Horizontal or Vertical Flip, which
            are set to 50% always.
          maximum: 1
          minimum: 0
          type: number
        transformations:
          description: List of Transformations to possibly apply to each image
          items:
            $ref: '#/components/schemas/Transformation'
          type: array
      required:
      - name
      - numberOfNewImages
      - projectId
      - transformationProbability
      - transformations
      type: object
    ImageAugmentationListsCreateSamples:
      properties:
        numberOfRows:
          description: Number of images from the original dataset to be augmented
          minimum: 1
          type: integer
      required:
      - numberOfRows
      type: object
    ImageAugmentationListsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: The content in the form of an augmentation lists
          items:
            $ref: '#/components/schemas/ImageAugmentationListsRetrieve'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImageAugmentationListsRetrieve:
      properties:
        featureName:
          description: The name of the image feature containing the data to be augmented
          type: string
        id:
          description: Image Augmentation list ID
          type: string
        inUse:
          default: false
          description: This is set to true when the Augmentation List has been used
            to train a model
          type: boolean
        initialList:
          default: false
          description: Whether this list will be used during autopilot to perform
            image augmentation
          type: boolean
        name:
          description: The name of the image augmentation list
          type: string
        numberOfNewImages:
          description: Number of new rows to add for each existing row
          minimum: 1
          type: integer
        projectId:
          description: The project containing the image data to be augmented
          type: string
        samplesId:
          default: null
          description: Image Augmentation list samples ID
          nullable: true
          type: string
        transformationProbability:
          description: Probability that each enabled transformation will be applied
            to an image. This does not apply to Horizontal or Vertical Flip, which
            are set to 50% always.
          maximum: 1
          minimum: 0
          type: number
        transformations:
          description: List of Transformations to possibly apply to each image
          items:
            $ref: '#/components/schemas/Transformation'
          type: array
      required:
      - id
      - name
      - numberOfNewImages
      - projectId
      - transformationProbability
      - transformations
      type: object
    ImageAugmentationListsRetrieveSamplesResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Augmentation samples list
          items:
            $ref: '#/components/schemas/ImageAugmentationRetrieveSamplesItem'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImageAugmentationOptionsResponse:
      properties:
        currentNumberOfNewImages:
          description: Number of new images to be created for each original image
            during training
          type: integer
        currentTransformationProbability:
          description: Probability that each transformation included in an augmentation
            list will be applied to an image, if `affectedByTransformationProbability`
            for that transformation is True
          type: number
        featureName:
          description: Name of the image feature that the augmentation list is associated
            with
          type: string
        id:
          description: Augmentation list id
          type: string
        maxNumberOfNewImages:
          description: Maximum number of new images per original image to be generated
            during training
          type: integer
        maxTransformationProbability:
          description: Maximum probability that each enabled augmentation will be
            applied to an image
          maximum: 1.0
          type: number
        minNumberOfNewImages:
          description: Minimum number of new images per original image to be generated
            during training
          type: integer
        minTransformationProbability:
          description: Minimum probability that each enabled augmentation will be
            applied to an image
          minimum: 0.0
          type: number
        name:
          description: The name of the augmentation list
          type: string
        projectId:
          description: The id of the project containing the image data to be augmented
          type: string
        transformations:
          description: List of Transformations to possibly apply to each image
          items:
            $ref: '#/components/schemas/ImageAugmentationOptionsTransformation'
          type: array
      required:
      - currentNumberOfNewImages
      - currentTransformationProbability
      - id
      - maxNumberOfNewImages
      - maxTransformationProbability
      - minNumberOfNewImages
      - minTransformationProbability
      - name
      - projectId
      - transformations
      type: object
    ImageAugmentationOptionsTransformation:
      properties:
        affectedByTransformationProbability:
          description: 'If true, whenever this transformation is included in an augmentation
            list, this transformation will be applied to each image with probability
            set by the Transformation Probability. If false, whenever this transformation
            is included in an augmentation list, this transformation will be applied
            to each image with probability described in the Platform Documentation
            here: https://docs.datarobot.com/en/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations'
          type: boolean
        enabledByDefault:
          description: Determines if the parameter should be default selected in the
            UI
          type: boolean
        name:
          description: The name of the transformation
          type: string
        params:
          description: The list of parameters that control the transformation
          items:
            $ref: '#/components/schemas/ImageAugmentationOptionsTransformationParam'
          type: array
        translatedName:
          description: Translated name of the transformation
          type: string
      required:
      - affectedByTransformationProbability
      - enabledByDefault
      - name
      - params
      - translatedName
      type: object
    ImageAugmentationOptionsTransformationParam:
      properties:
        currentValue:
          anyOf:
          - type: integer
          - type: number
          description: Current transformation value
        maxValue:
          anyOf:
          - type: integer
          - type: number
          description: Max transformation value
        minValue:
          anyOf:
          - type: integer
          - type: number
          description: Min transformation value
        name:
          description: Transformation param name
          type: string
        translatedName:
          description: Translated name of the parameter
          type: string
        type:
          description: The type of the parameter (int, float, etc...)
          type: string
      required:
      - name
      - translatedName
      - type
      type: object
    ImageAugmentationRetrieveSamplesItem:
      properties:
        height:
          description: Height of the image in pixels
          type: integer
        imageId:
          description: Id of the image. The augmented image file can be retrieved
            with :http:get:`/api/v2/projects/(projectId)/images/(imageId)/file/`
          type: string
        originalImageId:
          description: 'Id of the original image that was transformed to produce the
            augmented image. If this is an original image (from the original training
            dataset) this value will be null. The id can be used to retrieve the original
            image file with: :http:get:`/api/v2/projects/(projectId)/images/(imageId)/file/`'
          nullable: true
          type: string
        projectId:
          description: Project id
          type: string
        width:
          description: Width of the image in pixels
          type: integer
      required:
      - height
      - imageId
      - originalImageId
      - projectId
      - width
      type: object
    ImageAugmentationRetrieveSamplesResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Augmentation samples list
          items:
            $ref: '#/components/schemas/ImageAugmentationRetrieveSamplesItem'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImageAugmentationSamplesRequest:
      properties:
        featureName:
          description: The name of the image feature containing the data to be augmented
          type: string
        id:
          description: Augmentation list id
          type: string
        inUse:
          default: false
          description: This is set to true when the Augmentation List has been used
            to train a model
          type: boolean
        initialList:
          default: false
          description: Whether this list will be used during autopilot to perform
            image augmentation
          type: boolean
        name:
          description: The name of the image augmentation list
          type: string
        numberOfNewImages:
          description: Number of new rows to add for each existing row
          minimum: 1
          type: integer
        numberOfRows:
          description: Number of images from the original dataset to be augmented
          minimum: 1
          type: integer
        projectId:
          description: The project containing the image data to be augmented
          type: string
        samplesId:
          default: null
          description: Image Augmentation list samples ID
          nullable: true
          type: string
        transformationProbability:
          description: Probability that each enabled transformation will be applied
            to an image. This does not apply to Horizontal or Vertical Flip, which
            are set to 50% always.
          maximum: 1
          minimum: 0
          type: number
        transformations:
          description: List of Transformations to possibly apply to each image
          items:
            $ref: '#/components/schemas/Transformation'
          type: array
      required:
      - name
      - numberOfNewImages
      - numberOfRows
      - projectId
      - transformationProbability
      - transformations
      type: object
    ImageAugmentationSamplesResponse:
      properties:
        statusId:
          description: Id of the newly created augmentation samples which can be used
            to retrieve the full set of sample images.
          type: string
      required:
      - statusId
      type: object
    ImageBinsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of image metadata, as described below
          items:
            $ref: '#/components/schemas/ImageMetadataWithBins'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImageEmbedding:
      properties:
        actualTargetValue:
          description: Actual target value of the dataset row
          nullable: true
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
        imageId:
          description: Id of the image. The actual image file can be retrieved with
            :http:get:`/api/v2/projects/(projectId)/images/(imageId)/file/`.
          type: string
        positionX:
          description: x coordinate of the image in the embedding space.
          type: number
        positionY:
          description: y coordinate of the image in the embedding space.
          type: number
        prediction:
          $ref: '#/components/schemas/InsightsPredictionField'
          description: Object that describes prediction value of the dataset row.
          nullable: true
      required:
      - actualTargetValue
      - imageId
      - positionX
      - positionY
      - prediction
      type: object
    ImageEmbeddingsComputeResponse:
      properties:
        id:
          description: The job ID.
          type: string
        isBlocked:
          description: True if the job is waiting for its dependencies to be resolved
            first.
          type: boolean
        jobType:
          description: the type of the job
          enum:
          - compute_image_embeddings
          type: string
        message:
          description: Error message in case of failure.
          type: string
        modelId:
          description: the model ID of the target model
          type: string
        projectId:
          description: The project the job belongs to.
          type: string
        status:
          description: The job status.
          enum:
          - queue
          - inprogress
          - error
          - ABORTED
          - COMPLETED
          type: string
        url:
          description: A URL that can be used to request details about the job.
          type: string
      required:
      - id
      - isBlocked
      - jobType
      - message
      - modelId
      - projectId
      - status
      - url
      type: object
    ImageFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          nullable: true
          type: number
        featureName:
          description: Feature name.
          type: string
        featureType:
          description: Feature Type.
          enum:
          - image
          type: string
        insights:
          description: A list of Cluster Insights for an image feature.
          items:
            $ref: '#/components/schemas/ImageInsights'
          type: array
      required:
      - featureName
      - featureType
      - insights
      type: object
    ImageInsights:
      properties:
        allData:
          $ref: '#/components/schemas/AllDataImage'
          description: Statistics for all data for different feature values.
        insightName:
          description: Insight name.
          enum:
          - representativeImages
          type: string
        perCluster:
          description: Statistic values for different feature values in this cluster.
          items:
            $ref: '#/components/schemas/PerClusterImage'
          type: array
      required:
      - insightName
      - perCluster
      type: object
    ImageInsightsMetadataElement:
      properties:
        featureName:
          description: Name of feature
          type: string
        modelId:
          description: Model ID of the target model
          type: string
      required:
      - featureName
      - modelId
      type: object
    ImageMetadataListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of image metadata elements
          items:
            $ref: '#/components/schemas/ImageMetadataResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImageMetadataResponse:
      properties:
        height:
          description: Height of the image in pixels
          type: integer
        imageId:
          description: Id of the image. The actual image file can be retrieved with
            :http:get:`/api/v2/projects/(projectId)/images/(imageId)/file/`
          type: string
        targetValue:
          description: Target value
          type: number
        width:
          description: Width of the image in pixels
          type: integer
      required:
      - height
      - imageId
      - width
      type: object
    ImageMetadataWithBins:
      properties:
        height:
          description: Height of the image in pixels
          type: integer
        imageId:
          description: Id of the image. The actual image file can be retrieved with
            :http:get:`/api/v2/projects/(projectId)/images/(imageId)/file/`
          type: string
        targetBinEnd:
          description: Target value for bin end for regression, null for classification
          nullable: true
          type: integer
        targetBinRowCount:
          description: Number of rows in this target bin
          type: integer
        targetBinStart:
          description: Target value for bin start for regression, null for classification
          nullable: true
          type: integer
        targetValue:
          description: Target value
          type: number
        width:
          description: Width of the image in pixels
          type: integer
      required:
      - height
      - imageId
      - targetBinRowCount
      - width
      type: object
    ImagesDataQualityLogLinesResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: The content in the form of lines of the images data quality
            log
          items:
            description: Log lines
            type: string
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    InsightsPredictionField:
      properties:
        labels:
          description: List of predicted label names corresponding to values.
          items:
            description: Predicted label
            type: string
          nullable: true
          type: array
        values:
          description: Predicted value or probability of the class identified by the
            label.
          items:
            oneOf:
            - type: number
            - items:
                type: number
              type: array
          type: array
      required:
      - labels
      - values
      type: object
    InstructionsField:
      properties:
        owner:
          description: Instructions owner
          type: string
        user:
          description: Instructions user
          type: string
      required:
      - owner
      - user
      type: object
    Int:
      properties:
        max:
          description: Maximum value for the parameter.
          type: integer
        min:
          description: Minimum value for the parameter.
          type: integer
        supportsGridSearch:
          description: When True, Grid Search is supported for this parameter.
          type: boolean
      required:
      - max
      - min
      - supportsGridSearch
      type: object
    IntList:
      properties:
        maxLength:
          description: Maximum permitted length of the list.
          minimum: 0
          type: integer
        maxVal:
          description: Maximum permitted value.
          type: integer
        minLength:
          description: Minimum permitted length of the list.
          minimum: 0
          type: integer
        minVal:
          description: Minimum permitted value.
          type: integer
        supportsGridSearch:
          description: When True, Grid Search is supported for this parameter.
          type: boolean
      required:
      - maxLength
      - maxVal
      - minLength
      - minVal
      - supportsGridSearch
      type: object
    JDBCDataStoreCreate:
      properties:
        driverId:
          description: Driver ID.
          type: string
        jdbcFields:
          description: 'The fields used to create the JDBC URL, in the form of a JSON
            object where parameter name/value pairs are the items in the object. For
            example: `{"address": localhost:5432, "database": "fooBar", "connectTimeout":
            10}`. In most cases, all keys in `jdbcFields` should be defined by a schema
            listed in `jdbcFieldSchemas` from `DriverConfiguration`. The request will
            be rejected if there are required parameters (as defined by `jdbcFieldSchemas`)
            that are not provided.'
          items:
            $ref: '#/components/schemas/JDBCFields'
          maxItems: 100
          type: array
          x-versionadded: v2.18
        jdbcUrl:
          description: JDBC URL.
          type: string
      required:
      - driverId
      type: object
    JDBCDataStoreDetails:
      properties:
        driverId:
          description: Driver ID.
          type: string
        jdbcFieldSchemas:
          default: []
          description: Fields to show when creating a data store, their defaults,
            whether or not they are required, and more.
          items:
            $ref: '#/components/schemas/JDBCFieldSchemas'
          maxItems: 100
          type: array
        jdbcFields:
          description: 'The fields used to create the JDBC URL, in the form of a JSON
            object where parameter name/value pairs are the items in the object. For
            example: `{"address": localhost:5432, "database": "fooBar", "connectTimeout":
            10}`. In most cases, all keys in `jdbcFields` should be defined by a schema
            listed in `jdbcFieldSchemas` from `DriverConfiguration`. The request will
            be rejected if there are required parameters (as defined by `jdbcFieldSchemas`)
            that are not provided.'
          items:
            $ref: '#/components/schemas/JDBCFields'
          maxItems: 100
          type: array
          x-versionadded: v2.18
        jdbcUrl:
          description: JDBC URL.
          type: string
      required:
      - driverId
      type: object
    JDBCDataStoreUpdate:
      properties:
        driverId:
          description: Driver ID.
          type: string
        jdbcFields:
          description: 'The fields used to create the JDBC URL, in the form of a JSON
            object where parameter name/value pairs are the items in the object. For
            example: `{"address": localhost:5432, "database": "fooBar", "connectTimeout":
            10}`. In most cases, all keys in `jdbcFields` should be defined by a schema
            listed in `jdbcFieldSchemas` from `DriverConfiguration`. The request will
            be rejected if there are required parameters (as defined by `jdbcFieldSchemas`)
            that are not provided.'
          items:
            $ref: '#/components/schemas/JDBCFields'
          maxItems: 100
          type: array
          x-versionadded: v2.18
        jdbcUrl:
          description: JDBC URL.
          type: string
      type: object
    JDBCDataStreamer:
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
          x-versionadded: v2.22
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the JDBC data source.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: ID of the data store to connect to
            type: string
          - enum:
            - '[redacted]'
            type: string
        fetchSize:
          description: A user specified fetch size. Changing it can be used to balance
            throughput and memory usage. Deprecated and ignored since v2.21.
          maximum: 1000000
          minimum: 1
          type: integer
        query:
          description: 'A self-supplied SELECT statement of the dataset you wish to
            score. Helpful for supplying a more fine-grained selection of data not
            achievable through specification of "table" and/or "schema" parameters
            exclusively.If this job is executed with a job definition, then template
            variables are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        schema:
          description: The name of the specified database schema to read input data
            from.
          type: string
        table:
          description: The name of the specified database table to read input data
            from.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - jdbc
          type: string
      required:
      - dataStoreId
      - type
      type: object
    JDBCFieldSchemas:
      properties:
        choices:
          default: []
          description: If non-empty, a list of all possible values for this parameter.
          items:
            description: Possible value for this parameter.
            type: string
          type: array
        default:
          description: Default value of the JDBC parameter.
          type: string
        description:
          default: ''
          description: Description of this parameter.
          type: string
        index:
          description: Sort order within one `kind`.
          type: integer
        kind:
          description: Use of this parameter in constructing the JDBC URL.
          enum:
          - ADDRESS
          - EXTENDED_PATH_PARAM
          - PATH_PARAM
          - QUERY_PARAM
          type: string
        name:
          description: Name of the JDBC parameter.
          type: string
        required:
          description: Whether or not the parameter is required for a connection.
          type: boolean
        visibleByDefault:
          description: Whether or not the parameter should be shown in the UI by default.
          type: boolean
      required:
      - choices
      - default
      - description
      - kind
      - name
      - required
      - visibleByDefault
      type: object
    JDBCFields:
      properties:
        name:
          description: Name of the JDBC parameter.
          type: string
        value:
          description: Value of the JDBC parameter.
          type: string
      required:
      - name
      - value
      type: object
    JDBCIntake:
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
          x-versionadded: v2.22
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the JDBC data source.
          nullable: true
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          type: string
        fetchSize:
          description: A user specified fetch size. Changing it can be used to balance
            throughput and memory usage. Deprecated and ignored since v2.21.
          maximum: 1000000
          minimum: 1
          type: integer
        query:
          description: 'A self-supplied SELECT statement of the dataset you wish to
            score. Helpful for supplying a more fine-grained selection of data not
            achievable through specification of "table" and/or "schema" parameters
            exclusively.If this job is executed with a job definition, then template
            variables are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        schema:
          description: The name of the specified database schema to read input data
            from.
          type: string
        table:
          description: The name of the specified database table to read input data
            from.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - jdbc
          type: string
      required:
      - dataStoreId
      - type
      type: object
    JDBCOutput:
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
          x-versionadded: v2.22
        commitInterval:
          default: 600
          description: Defines a time interval in seconds between each commit is done
            to the JDBC source. If set to 0, the batch prediction operation will write
            the entire job before committing.
          maximum: 86400
          minimum: 0
          type: integer
          x-versionadded: v2.21
        createTableIfNotExists:
          default: false
          description: Attempt to create the table first if no existing one is detected,
            before writing data with the strategy defined in the `statementType` parameter.
          type: boolean
          x-versionadded: v2.24
        credentialId:
          description: The ID of the credential holding information about a user with
            write access to the JDBC data source.
          nullable: true
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          type: string
        schema:
          description: The name of the specified database schema to write the results
            to.
          type: string
        statementType:
          description: 'The statement type to use when writing the results. Deprecation
            Warning: Use of `create_table` is now discouraged. Use one of the other
            possibilities along with the parameter `createTableIfNotExists` set to
            `true`.'
          enum:
          - createTable
          - create_table
          - insert
          - insertUpdate
          - insert_update
          - update
          type: string
        table:
          description: 'The name of the specified database table to write the results
            to.If this job is executed with a job definition, then template variables
            are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        type:
          description: Type name for this intake type
          enum:
          - jdbc
          type: string
        updateColumns:
          description: The column names to be updated if statementType is set to either
            update or upsert.
          items:
            type: string
          maxItems: 100
          type: array
        whereColumns:
          description: The column names to be used in the where clause if statementType
            is set to update or upsert.
          items:
            type: string
          maxItems: 100
          type: array
      required:
      - dataStoreId
      - statementType
      - table
      - type
      type: object
    JDBCTableDataSourceInputCreate:
      properties:
        canonicalName:
          description: Data source canonical name.
          type: string
          x-versionadded: v2.33
        catalog:
          description: Catalog name in the database if supported.
          maxLength: 256
          type: string
          x-versionadded: v2.33
        sampling:
          $ref: '#/components/schemas/SampleDirectiveCreate'
          default: null
          description: Sampling data transformation.
          nullable: true
          x-versionadded: v2.33
        schema:
          description: Schema associated with the table or view in the database if
            the data source is not query based.
          maxLength: 256
          type: string
          x-versionadded: v2.33
        table:
          description: Table or view name in the database if the data source is not
            query based.
          maxLength: 256
          type: string
          x-versionadded: v2.33
      required:
      - canonicalName
      - table
      type: object
    JdbcForeignKey:
      properties:
        foreignKey:
          $ref: '#/components/schemas/JdbcKeyInfo'
          description: Referred foreign key.
        keyType:
          description: Type of this key.
          enum:
          - '1'
          - '2'
          - '3'
          type: string
        name:
          description: Name of this key.
          type: string
        primaryKey:
          $ref: '#/components/schemas/JdbcKeyInfo'
          description: Referred primary key.
      required:
      - keyType
      - primaryKey
      type: object
    JdbcKeyInfo:
      properties:
        catalog:
          description: Catalog name.
          type: string
        column:
          description: Column name.
          type: string
        schema:
          description: Schema name.
          type: string
        table:
          description: Table name.
          type: string
      required:
      - catalog
      - column
      - table
      type: object
    JdbcOutputAdaptor:
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
          x-versionadded: v2.22
        commitInterval:
          default: 600
          description: Defines a time interval in seconds between each commit is done
            to the JDBC source. If set to 0, the batch prediction operation will write
            the entire job before committing.
          maximum: 86400
          minimum: 0
          type: integer
          x-versionadded: v2.21
        createTableIfNotExists:
          default: false
          description: Attempt to create the table first if no existing one is detected,
            before writing data with the strategy defined in the `statementType` parameter.
          type: boolean
          x-versionadded: v2.24
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the JDBC data source.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: ID of the data store to connect to
            type: string
          - enum:
            - '[redacted]'
            type: string
        schema:
          description: The name of the specified database schema to write the results
            to.
          type: string
        statementType:
          description: 'The statement type to use when writing the results. Deprecation
            Warning: Use of `create_table` is now discouraged. Use one of the other
            possibilities along with the parameter `createTableIfNotExists` set to
            `true`.'
          enum:
          - createTable
          - create_table
          - insert
          - insertUpdate
          - insert_update
          - update
          type: string
        table:
          description: 'The name of the specified database table to write the results
            to.If this job is executed with a job definition, then template variables
            are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        type:
          description: Type name for this intake type
          enum:
          - jdbc
          type: string
        updateColumns:
          description: The column names to be updated if statementType is set to either
            update or upsert.
          items:
            type: string
          maxItems: 100
          type: array
        whereColumns:
          description: The column names to be used in the where clause if statementType
            is set to update or upsert.
          items:
            type: string
          maxItems: 100
          type: array
      required:
      - dataStoreId
      - statementType
      - table
      - type
      type: object
    JobDetailsResponse:
      properties:
        id:
          description: The job ID.
          type: string
        isBlocked:
          description: True if the job is waiting for its dependencies to be resolved
            first.
          type: boolean
        jobType:
          description: The job type.
          enum:
          - model
          - predict
          - trainingPredictions
          - featureImpact
          - featureEffects
          - shapImpact
          - anomalyAssessment
          - shapExplanations
          - shapMatrix
          - reasonCodesInitialization
          - reasonCodes
          - predictionExplanations
          - predictionExplanationsInitialization
          - primeDownloadValidation
          - ruleFitDownloadValidation
          - primeRulesets
          - primeModel
          - modelExport
          - usageData
          - modelXRay
          - accuracyOverTime
          - seriesAccuracy
          - validateRatingTable
          - generateComplianceDocumentation
          - automatedDocumentation
          - eda
          - pipeline
          - calculatePredictionIntervals
          - calculatePredictionIntervalBoundUsingOnlineConformal
          - batchVarTypeTransform
          - computeImageActivationMaps
          - computeImageAugmentations
          - computeImageEmbeddings
          - computeDocumentTextExtractionSamples
          - externalDatasetInsights
          - startDatetimePartitioning
          - runSegmentationTasks
          - piiDetection
          - computeBiasAndFairness
          - sensitivityTesting
          - clusterInsights
          - scoringCodeBundleExport
          - onnxExport
          - scoringCodeSegmentedModeling
          - insights
          - distributionPredictionModel
          - batchScoringAvailableForecastPoints
          - notebooksScheduling
          - uncategorized
          type: string
        message:
          description: Error message in case of failure.
          type: string
        modelId:
          description: The model this job is associated with.
          type: string
        projectId:
          description: The project the job belongs to.
          type: string
        status:
          description: The job status.
          enum:
          - queue
          - inprogress
          - error
          - ABORTED
          - COMPLETED
          type: string
        url:
          description: A URL that can be used to request details about the job.
          type: string
      required:
      - id
      - isBlocked
      - jobType
      - message
      - modelId
      - projectId
      - status
      - url
      type: object
    JobListResponse:
      properties:
        count:
          description: the number of jobs returned.
          type: integer
        jobs:
          description: A json array of jobs
          items:
            $ref: '#/components/schemas/JobDetailsResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          nullable: true
          type: string
      required:
      - count
      - jobs
      - next
      - previous
      type: object
    JobRunTimeBasedForecastPointPolicy:
      properties:
        configuration:
          $ref: '#/components/schemas/JobRunTimeBasedForecastPointPolicySettings'
          description: Customize if forecast point based on job run time needs to
            be shifted.
        type:
          description: Type of the forecast point policy. Forecast point will be based
            on the scheduled run time of the job or the current moment in UTC if job
            was launched manually. Run time can be adjusted backwards or forwards.
          enum:
          - jobRunTimeBased
          type: string
      required:
      - type
      type: object
    JobRunTimeBasedForecastPointPolicySettings:
      properties:
        offset:
          description: Offset to apply to scheduled run time of the job in a ISO-8601
            format toobtain a relative forecast point. Example of the positive offset
            'P2DT5H3M', example of the negative offset '-P2DT5H4M'
          format: offset
          type: string
      required:
      - offset
      type: object
    JoinDirectiveArguments:
      properties:
        joinType:
          description: The join type between primary and secondary data sources.
          enum:
          - inner
          - left
          type: string
          x-versionadded: v2.33
        leftKeys:
          description: The list of columns to be used in the "ON" clause from the
            primary data source.
          items:
            type: string
          maxItems: 10000
          minItems: 1
          type: array
          x-versionadded: v2.33
        rightDataSourceId:
          description: The ID of the input data source.
          type: string
          x-versionadded: v2.33
        rightKeys:
          description: The list of columns to be used in the "ON" clause from a secondary
            data source.
          items:
            type: string
          maxItems: 10000
          minItems: 1
          type: array
          x-versionadded: v2.33
        source:
          description: The source type.
          enum:
          - table
          type: string
          x-versionadded: v2.33
      required:
      - joinType
      - leftKeys
      - rightDataSourceId
      - rightKeys
      - source
      type: object
    LabelRelevancePlot:
      properties:
        labelRelevance:
          description: Label relevance value.
          maximum: 1
          minimum: 0
          type: integer
        rowCount:
          description: Number of rows for which the label has the given relevance.
          minimum: 0
          type: integer
        rowPct:
          description: Percentage of rows for which the label has the given relevance.
          maximum: 100
          minimum: 0
          type: number
      required:
      - labelRelevance
      - rowCount
      - rowPct
      type: object
    LabelwiseLiftChart:
      properties:
        labelBins:
          description: Lift charts for the given data source.
          items:
            $ref: '#/components/schemas/LabelwiseLiftChartItem'
          maxItems: 100
          type: array
        labels:
          description: All available target labels for this insight.
          items:
            description: Label name.
            type: string
          maxItems: 100
          type: array
        modelId:
          description: Model Id.
          type: string
        projectId:
          description: Project Id.
          type: string
        source:
          description: Data source of Lift charts.
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      required:
      - labelBins
      - labels
      - modelId
      - projectId
      - source
      type: object
    LabelwiseLiftChartBin:
      properties:
        actual:
          description: Average of actual target values for the rows in the bin.
          type: number
        binWeight:
          description: For projects with weights, it is the sum of the weights of
            all rows in the bins. Otherwise, it is the number of rows in the bin.
          type: number
        predicted:
          description: Average of predicted target values for the rows in the bin.
          type: number
      required:
      - actual
      - binWeight
      - predicted
      type: object
    LabelwiseLiftChartItem:
      properties:
        bins:
          description: Lift chart data for that label.
          items:
            $ref: '#/components/schemas/LabelwiseLiftChartBin'
          maxItems: 60
          type: array
        label:
          description: Label name.
          type: string
      required:
      - bins
      - label
      type: object
    LabelwiseROC:
      properties:
        averageModelMetrics:
          $ref: '#/components/schemas/AverageModelMetricsField'
          description: All average model metrics from one data source.
          nullable: true
        charts:
          description: ROC data for all labels from one data source.
          items:
            $ref: '#/components/schemas/LabelwiseROCItem'
          type: array
        count:
          description: Number of labels returned on this page.
          type: integer
        labels:
          description: All available target labels for this insight.
          items:
            description: Label name.
            type: string
          maxItems: 100
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        rocType:
          description: Type of ROC.
          enum:
          - binary
          - labelwise
          type: string
        totalCount:
          description: Total number of labels across all pages.
          type: integer
      required:
      - averageModelMetrics
      - charts
      - labels
      - next
      - previous
      - rocType
      - totalCount
      type: object
    LabelwiseROCItem:
      properties:
        auc:
          description: Area under the curve.
          type: number
        kolmogorovSmirnovMetric:
          description: Kolmogorov-Smirnov metric.
          type: number
        label:
          description: Label name.
          type: string
        negativeClassPredictions:
          description: List of example predictions for the negative class.
          items:
            type: number
          type: array
        positiveClassPredictions:
          description: List of example predictions for the positive class.
          items:
            type: number
          type: array
        rocPoints:
          description: ROC characteristics for label.
          items:
            $ref: '#/components/schemas/LabelwiseROCPoint'
          type: array
        source:
          description: Data source of ROC characteristics.
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      required:
      - auc
      - kolmogorovSmirnovMetric
      - label
      - negativeClassPredictions
      - positiveClassPredictions
      - rocPoints
      - source
      type: object
    LabelwiseROCPoint:
      properties:
        accuracy:
          description: Accuracy.
          maximum: 1
          minimum: 0
          type: number
        f1Score:
          description: F1 score.
          maximum: 1
          minimum: 0
          type: number
        falseNegativeScore:
          description: False negative score.
          minimum: 0
          nullable: true
          type: integer
        falsePositiveRate:
          description: False positive rate.
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        falsePositiveScore:
          description: False positive score.
          minimum: 0
          nullable: true
          type: integer
        fractionPredictedAsNegative:
          description: Fraction of negative predictions.
          nullable: true
          type: number
        fractionPredictedAsPositive:
          description: Fraction of positive predictions.
          nullable: true
          type: number
        liftNegative:
          description: Negative lift.
          nullable: true
          type: number
        liftPositive:
          description: Positive lift.
          nullable: true
          type: number
        matthewsCorrelationCoefficient:
          description: Matthews correlation coefficient.
          maximum: 1
          minimum: -1
          type: number
        negativePredictiveValue:
          description: Negative predictive value.
          maximum: 1
          minimum: 0
          type: number
        positivePredictiveValue:
          description: Positive predictive value.
          maximum: 1
          minimum: 0
          type: number
        threshold:
          description: Threshold.
          maximum: 2
          minimum: 0
          type: number
        trueNegativeRate:
          description: True negative rate.
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        trueNegativeScore:
          description: True negative score.
          minimum: 0
          nullable: true
          type: integer
        truePositiveRate:
          description: True positive rate.
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        truePositiveScore:
          description: True positive score.
          minimum: 0
          nullable: true
          type: integer
      required:
      - accuracy
      - f1Score
      - falseNegativeScore
      - falsePositiveRate
      - falsePositiveScore
      - fractionPredictedAsNegative
      - fractionPredictedAsPositive
      - liftNegative
      - liftPositive
      - matthewsCorrelationCoefficient
      - negativePredictiveValue
      - positivePredictiveValue
      - threshold
      - trueNegativeRate
      - trueNegativeScore
      - truePositiveRate
      - truePositiveScore
      type: object
    LagsDirectiveArguments:
      properties:
        column:
          description: Column name.
          type: string
          x-versionadded: v2.33
        datetimePartitionColumn:
          description: A column, which is used to order data.
          type: string
          x-versionadded: v2.33
        multiseriesIdColumn:
          default: null
          description: Series ID column, if present. Partition data by it.
          nullable: true
          type: string
          x-versionadded: v2.33
        orders:
          description: Lag orders.
          items:
            exclusiveMinimum: true
            minimum: 0
            type: integer
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - column
      - datetimePartitionColumn
      - orders
      type: object
    LiftBinResponse:
      properties:
        actual:
          description: The average of the actual target values for the rows in the
            bin.
          type: number
        binWeight:
          description: How much data is in the bin. For projects with weights, it
            is the sum of the weights of all rows in the bins; otherwise, it is the
            number of rows in the bin.
          type: number
        predicted:
          description: The average of predicted values of the target for the rows
            in the bin.
          type: number
      required:
      - actual
      - binWeight
      - predicted
      type: object
    LiftChartForDatasetsList:
      properties:
        count:
          description: Number of results returned on this page.
          type: integer
        data:
          description: Array of lift chart data for dataset, as specified below
          items:
            $ref: '#/components/schemas/LiftData'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    LiftChartResponse:
      properties:
        bins:
          description: The lift chart data for that source, as specified below.
          items:
            $ref: '#/components/schemas/LiftBinResponse'
          type: array
      required:
      - bins
      type: object
    LiftChartbins:
      properties:
        actual:
          description: The average of the actual target values for the rows in the
            bin.
          type: number
        binWeight:
          description: How much data is in the bin. For projects with weights, it
            is the sum of the weights of all rows in the bins; otherwise, it is the
            number of rows in the bin.
          type: number
        predicted:
          description: The average of predicted values of the target for the rows
            in the bin.
          type: number
      required:
      - actual
      - binWeight
      - predicted
      type: object
    LiftData:
      properties:
        bins:
          description: The lift chart data for that source, as specified below.
          items:
            $ref: '#/components/schemas/LiftChartbins'
          type: array
        datasetId:
          description: The dataset id of dataset which was used to compute Lift chart.
          type: string
      required:
      - bins
      - datasetId
      type: object
    LimitDirectiveArguments:
      properties:
        rows:
          default: 1000
          description: The number of rows to be selected.
          maximum: 10000
          minimum: 1
          type: integer
          x-versionadded: v2.33
      required:
      - rows
      type: object
    ListCredentialsAssociationsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of credentials associations.
          items:
            $ref: '#/components/schemas/RetrieveCredentialAssociationResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ListSsoConfigurationResponse:
      properties:
        count:
          description: Number of SSO configurations returned.
          minimum: 0
          type: integer
        data:
          description: SSO configuration.
          items:
            $ref: '#/components/schemas/EnhancedSsoConfigurationResponse'
          type: array
        next:
          description: Link to the next page of the SSO configurations.
          nullable: true
          type: string
        previous:
          description: Link to the previous page of the SSO configurations.
          nullable: true
          type: string
        totalCount:
          description: Total number of SSO configurations.
          minimum: 0
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ListUsersInGroupResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of users in the group.
          items:
            $ref: '#/components/schemas/UserInGroup'
          type: array
        next:
          description: The URL to the next page.
          format: uri
          nullable: true
          type: string
        previous:
          description: The URL to the previous page.
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items that match the query condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    LocalFileDataStreamer:
      properties:
        async:
          description: 'The default behavior (async: true) will still submit the job
            to the queue and start processing as soon as the upload is started.Setting
            it to false will postpone submitting the job to the queue until all data
            has been uploaded.This is helpful if the user is on a bad connection and
            bottlednecked by the upload speed. Instead of blocking the queue this
            will allow others to submit to the queue until the upload has finished.'
          nullable: true
          type: boolean
          x-versionadded: v2.28
        multipart:
          description: specify if the data will be uploaded in multiple parts instead
            of a single file
          type: boolean
          x-versionadded: v2.27
        type:
          description: Type name for this intake type
          enum:
          - local_file
          - localFile
          type: string
      required:
      - type
      type: object
    LocalFileIntake:
      properties:
        async:
          description: 'The default behavior (async: true) will still submit the job
            to the queue and start processing as soon as the upload is started.Setting
            it to false will postpone submitting the job to the queue until all data
            has been uploaded.This is helpful if the user is on a bad connection and
            bottlednecked by the upload speed. Instead of blocking the queue this
            will allow others to submit to the queue until the upload has finished.'
          nullable: true
          type: boolean
          x-versionadded: v2.28
        multipart:
          description: specify if the data will be uploaded in multiple parts instead
            of a single file
          type: boolean
          x-versionadded: v2.27
        type:
          description: Type name for this intake type
          enum:
          - local_file
          - localFile
          type: string
      required:
      - type
      type: object
    LocalFileOutput:
      properties:
        type:
          description: Type name for this output type
          enum:
          - local_file
          - localFile
          type: string
      required:
      - type
      type: object
    LocalFileOutputAdaptor:
      properties:
        type:
          description: Type name for this output type
          enum:
          - local_file
          - localFile
          type: string
      required:
      - type
      type: object
    MaterializationDestination:
      properties:
        catalog:
          description: Database to materialize the recipe to.
          type: string
          x-versionadded: v2.33
        schema:
          description: Schema to materialize the recipe to.
          type: string
          x-versionadded: v2.33
        table:
          description: Table name to create and materialize the recipe to. This table
            should not already exist.
          type: string
          x-versionadded: v2.33
      required:
      - catalog
      - schema
      - table
      type: object
    MeanProbability:
      properties:
        className:
          description: Name of the class
          type: string
        value:
          description: Mean predicted probability for a class for all rows in the
            bucket
          type: number
      required:
      - className
      - value
      type: object
    MessagesInfo:
      properties:
        messages:
          description: List of data quality messages. The list may include reports
            on more than one data quality issue, if present.
          items:
            $ref: '#/components/schemas/OneMessageInfo'
          maxItems: 50
          minItems: 1
          type: array
      required:
      - messages
      type: object
    MetricBaselineValue:
      properties:
        value:
          description: A reference value in given metric units.
          type: number
      required:
      - value
      type: object
    MetricCreatePayload:
      properties:
        baselineValues:
          default: []
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        description:
          description: A description of the custom metric.
          maxLength: 1000
          type: string
        directionality:
          description: Directionality of the custom metric.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type: string
        isModelSpecific:
          description: Determines whether the metric is related to the model or deployment.
          type: boolean
        name:
          description: Name of the custom metric.
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
          description: Points to a weight column if users provide pre-aggregated metric
            values. Used with columnar datasets.
        timeStep:
          default: hour
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
          description: A custom metric timestamp spoofing when reading values from
            file, like dataset. By default, we replicate pd.to_datetime formatting
            behaviour.
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type: string
        value:
          $ref: '#/components/schemas/ValueField'
          description: A custom metric value source when reading values from columnar
            dataset like a file.
      required:
      - baselineValues
      - directionality
      - isModelSpecific
      - name
      - timeStep
      - type
      - units
      type: object
    MetricCreatedBy:
      properties:
        id:
          description: The ID of user who created custom metric.
          type: string
      required:
      - id
      type: object
    MetricDetail:
      properties:
        ascending:
          description: Should the metric be sorted in ascending order
          type: boolean
        name:
          description: Name of the metric
          type: string
      required:
      - ascending
      - name
      type: object
    MetricEntity:
      properties:
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        createdAt:
          description: Custom metric creation timestamp.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/MetricCreatedBy'
          description: The user that created custom metric.
        description:
          description: A description of the custom metric.
          maxLength: 1000
          type: string
        directionality:
          description: Directionality of the custom metric.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type: string
        displayChart:
          description: Indicates if UI should show chart by default.
          type: boolean
        id:
          description: The ID of the custom metric.
          type: string
        isModelSpecific:
          description: Determines whether the metric is related to the model or deployment.
          type: boolean
        name:
          description: Name of the custom metric.
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
          description: Points to a weight column if users provide pre-aggregated metric
            values. Used with columnar datasets.
        timeStep:
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
          description: A custom metric timestamp spoofing when reading values from
            file, like dataset. By default, we replicate pd.to_datetime formatting
            behaviour.
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type: string
        value:
          $ref: '#/components/schemas/ValueField'
          description: A custom metric value source when reading values from columnar
            dataset like a file.
      required:
      - baselineValues
      - createdAt
      - createdBy
      - directionality
      - id
      - isModelSpecific
      - name
      - timeStep
      - type
      - units
      type: object
    MetricInputValueBucket:
      properties:
        sampleSize:
          default: 1
          description: Custom metric value sample size.
          type: integer
        timestamp:
          description: Value timestamp.
          format: date-time
          nullable: true
          type: string
        value:
          description: Custom metric value to ingest.
          type: number
      required:
      - value
      type: object
    MetricListResponse:
      properties:
        count:
          description: Number of paginated entries.
          minimum: 0
          type: integer
        data:
          description: A list of custom metrics.
          items:
            $ref: '#/components/schemas/MetricEntity'
          type: array
        next:
          description: URL to the next page, or null if there is no such page
          nullable: true
          type: string
        previous:
          description: URL to the previous page, or null if there is no such page
          nullable: true
          type: string
        totalCount:
          description: Total number of entries.
          minimum: 0
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    MetricPeriodBucket:
      properties:
        end:
          description: End of the bucket.
          format: date-time
          type: string
        start:
          description: Start of the bucket.
          format: date-time
          type: string
      required:
      - end
      - start
      type: object
    MetricSummary:
      properties:
        baselineValue:
          description: Baseline value.
          nullable: true
          type: number
        id:
          description: The ID of the custom metric.
          type: string
        name:
          description: Name of the custom metric.
          type: string
        percentChange:
          description: Percentage change of the baseline over its baseline.
          nullable: true
          type: number
        sampleCount:
          description: Number of samples used to calculate the aggregated value.
          nullable: true
          type: integer
        value:
          description: Aggregated value of the custom metric.
          nullable: true
          type: number
      required:
      - baselineValue
      - id
      - name
      - percentChange
      - sampleCount
      - value
      type: object
    MetricTimestampSpoofing:
      properties:
        columnName:
          description: Column name
          nullable: true
          type: string
        timeFormat:
          description: Format
          enum:
          - '%m/%d/%Y'
          - '%m/%d/%y'
          - '%d/%m/%y'
          - '%m-%d-%Y'
          - '%m-%d-%y'
          - '%Y/%m/%d'
          - '%Y-%m-%d'
          - '%Y-%m-%d %H:%M:%S'
          - '%Y/%m/%d %H:%M:%S'
          - '%Y.%m.%d %H:%M:%S'
          - '%Y-%m-%d %H:%M'
          - '%Y/%m/%d %H:%M'
          - '%y/%m/%d'
          - '%y-%m-%d'
          - '%y-%m-%d %H:%M:%S'
          - '%y.%m.%d %H:%M:%S'
          - '%y/%m/%d %H:%M:%S'
          - '%y-%m-%d %H:%M'
          - '%y.%m.%d %H:%M'
          - '%y/%m/%d %H:%M'
          - '%m/%d/%Y %H:%M'
          - '%m/%d/%y %H:%M'
          - '%d/%m/%Y %H:%M'
          - '%d/%m/%y %H:%M'
          - '%m-%d-%Y %H:%M'
          - '%m-%d-%y %H:%M'
          - '%d-%m-%Y %H:%M'
          - '%d-%m-%y %H:%M'
          - '%m.%d.%Y %H:%M'
          - '%m/%d.%y %H:%M'
          - '%d.%m.%Y %H:%M'
          - '%d.%m.%y %H:%M'
          - '%m/%d/%Y %H:%M:%S'
          - '%m/%d/%y %H:%M:%S'
          - '%m-%d-%Y %H:%M:%S'
          - '%m-%d-%y %H:%M:%S'
          - '%m.%d.%Y %H:%M:%S'
          - '%m.%d.%y %H:%M:%S'
          - '%d/%m/%Y %H:%M:%S'
          - '%d/%m/%y %H:%M:%S'
          - '%Y-%m-%d %H:%M:%S.%f'
          - '%y-%m-%d %H:%M:%S.%f'
          - '%Y-%m-%dT%H:%M:%S.%fZ'
          - '%y-%m-%dT%H:%M:%S.%fZ'
          - '%Y-%m-%dT%H:%M:%S.%f'
          - '%y-%m-%dT%H:%M:%S.%f'
          - '%Y-%m-%dT%H:%M:%S'
          - '%y-%m-%dT%H:%M:%S'
          - '%Y-%m-%dT%H:%M:%SZ'
          - '%y-%m-%dT%H:%M:%SZ'
          - '%Y.%m.%d %H:%M:%S.%f'
          - '%y.%m.%d %H:%M:%S.%f'
          - '%Y.%m.%dT%H:%M:%S.%fZ'
          - '%y.%m.%dT%H:%M:%S.%fZ'
          - '%Y.%m.%dT%H:%M:%S.%f'
          - '%y.%m.%dT%H:%M:%S.%f'
          - '%Y.%m.%dT%H:%M:%S'
          - '%y.%m.%dT%H:%M:%S'
          - '%Y.%m.%dT%H:%M:%SZ'
          - '%y.%m.%dT%H:%M:%SZ'
          - '%Y%m%d'
          - '%m %d %Y %H %M %S'
          - '%m %d %y %H %M %S'
          - '%H:%M'
          - '%M:%S'
          - '%H:%M:%S'
          - '%Y %m %d %H %M %S'
          - '%y %m %d %H %M %S'
          - '%Y %m %d'
          - '%y %m %d'
          - '%d/%m/%Y'
          - '%Y-%d-%m'
          - '%y-%d-%m'
          - '%Y/%d/%m %H:%M:%S.%f'
          - '%Y/%d/%m %H:%M:%S.%fZ'
          - '%Y/%m/%d %H:%M:%S.%f'
          - '%Y/%m/%d %H:%M:%S.%fZ'
          - '%y/%d/%m %H:%M:%S.%f'
          - '%y/%d/%m %H:%M:%S.%fZ'
          - '%y/%m/%d %H:%M:%S.%f'
          - '%y/%m/%d %H:%M:%S.%fZ'
          - '%m.%d.%Y'
          - '%m.%d.%y'
          - '%d.%m.%y'
          - '%d.%m.%Y'
          - '%Y.%m.%d'
          - '%Y.%d.%m'
          - '%y.%m.%d'
          - '%y.%d.%m'
          - '%Y-%m-%d %I:%M:%S %p'
          - '%Y/%m/%d %I:%M:%S %p'
          - '%Y.%m.%d %I:%M:%S %p'
          - '%Y-%m-%d %I:%M %p'
          - '%Y/%m/%d %I:%M %p'
          - '%y-%m-%d %I:%M:%S %p'
          - '%y.%m.%d %I:%M:%S %p'
          - '%y/%m/%d %I:%M:%S %p'
          - '%y-%m-%d %I:%M %p'
          - '%y.%m.%d %I:%M %p'
          - '%y/%m/%d %I:%M %p'
          - '%m/%d/%Y %I:%M %p'
          - '%m/%d/%y %I:%M %p'
          - '%d/%m/%Y %I:%M %p'
          - '%d/%m/%y %I:%M %p'
          - '%m-%d-%Y %I:%M %p'
          - '%m-%d-%y %I:%M %p'
          - '%d-%m-%Y %I:%M %p'
          - '%d-%m-%y %I:%M %p'
          - '%m.%d.%Y %I:%M %p'
          - '%m/%d.%y %I:%M %p'
          - '%d.%m.%Y %I:%M %p'
          - '%d.%m.%y %I:%M %p'
          - '%m/%d/%Y %I:%M:%S %p'
          - '%m/%d/%y %I:%M:%S %p'
          - '%m-%d-%Y %I:%M:%S %p'
          - '%m-%d-%y %I:%M:%S %p'
          - '%m.%d.%Y %I:%M:%S %p'
          - '%m.%d.%y %I:%M:%S %p'
          - '%d/%m/%Y %I:%M:%S %p'
          - '%d/%m/%y %I:%M:%S %p'
          - '%Y-%m-%d %I:%M:%S.%f %p'
          - '%y-%m-%d %I:%M:%S.%f %p'
          - '%Y-%m-%dT%I:%M:%S.%fZ %p'
          - '%y-%m-%dT%I:%M:%S.%fZ %p'
          - '%Y-%m-%dT%I:%M:%S.%f %p'
          - '%y-%m-%dT%I:%M:%S.%f %p'
          - '%Y-%m-%dT%I:%M:%S %p'
          - '%y-%m-%dT%I:%M:%S %p'
          - '%Y-%m-%dT%I:%M:%SZ %p'
          - '%y-%m-%dT%I:%M:%SZ %p'
          - '%Y.%m.%d %I:%M:%S.%f %p'
          - '%y.%m.%d %I:%M:%S.%f %p'
          - '%Y.%m.%dT%I:%M:%S.%fZ %p'
          - '%y.%m.%dT%I:%M:%S.%fZ %p'
          - '%Y.%m.%dT%I:%M:%S.%f %p'
          - '%y.%m.%dT%I:%M:%S.%f %p'
          - '%Y.%m.%dT%I:%M:%S %p'
          - '%y.%m.%dT%I:%M:%S %p'
          - '%Y.%m.%dT%I:%M:%SZ %p'
          - '%y.%m.%dT%I:%M:%SZ %p'
          - '%m %d %Y %I %M %S %p'
          - '%m %d %y %I %M %S %p'
          - '%I:%M %p'
          - '%I:%M:%S %p'
          - '%Y %m %d %I %M %S %p'
          - '%y %m %d %I %M %S %p'
          - '%Y/%d/%m %I:%M:%S.%f %p'
          - '%Y/%d/%m %I:%M:%S.%fZ %p'
          - '%Y/%m/%d %I:%M:%S.%f %p'
          - '%Y/%m/%d %I:%M:%S.%fZ %p'
          - '%y/%d/%m %I:%M:%S.%f %p'
          - '%y/%d/%m %I:%M:%S.%fZ %p'
          - '%y/%m/%d %I:%M:%S.%f %p'
          - '%y/%m/%d %I:%M:%S.%fZ %p'
          nullable: true
          type: string
      type: object
    MetricUpdatePayload:
      properties:
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        batch:
          $ref: '#/components/schemas/BatchField'
          description: A custom metric batch ID source when reading values from columnar
            dataset like a file.
        description:
          description: A description of the custom metric.
          maxLength: 1000
          type: string
        directionality:
          description: Directionality of the custom metric.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type: string
        name:
          description: Name of the custom metric.
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
          description: Points to a weight column if users provide pre-aggregated metric
            values. Used with columnar datasets.
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
          description: A custom metric timestamp spoofing when reading values from
            file, like dataset. By default, we replicate pd.to_datetime formatting
            behaviour.
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type: string
        value:
          $ref: '#/components/schemas/ValueField'
          description: A custom metric value source when reading values from columnar
            dataset like a file.
      type: object
    MetricValuesFromDatasetPayload:
      properties:
        associationId:
          $ref: '#/components/schemas/BatchField'
          description: Points to a custom metric associationId column, for saving
            predictions feedback.
        batch:
          $ref: '#/components/schemas/BatchField'
          description: A custom metric batch ID source when reading values from columnar
            dataset like a file.
        datasetId:
          description: Dataset ID to process.
          type: string
        modelId:
          default: null
          description: 'For a model metric: the ID of the model of related champion/challenger
            to update the metric values.For a deployment metric: the ID of the model
            is not needed.'
          nullable: true
          type: string
        modelPackageId:
          default: null
          description: 'For a model metric: the ID of the model package of related
            champion/challenger to update the metric values.For a deployment metric:
            the ID of the model package is not needed.'
          nullable: true
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
          description: Points to a weight column if users provide pre-aggregated metric
            values. Used with columnar datasets.
        segments:
          description: A list of segments for a custom metric used in segmented analysis.
          items:
            $ref: '#/components/schemas/CustomMetricSegmentDataset'
          maxItems: 10
          minItems: 1
          type: array
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
          description: A custom metric timestamp spoofing when reading values from
            file, like dataset. By default, we replicate pd.to_datetime formatting
            behaviour.
        value:
          $ref: '#/components/schemas/ValueField'
          description: A custom metric value source when reading values from columnar
            dataset like a file.
      required:
      - datasetId
      type: object
    MetricValuesFromJSONPayload:
      properties:
        buckets:
          description: A list of timestamped buckets with custom metric values.
          items:
            $ref: '#/components/schemas/MetricInputValueBucket'
          maxItems: 10000
          type: array
        dryRun:
          default: false
          description: Determines whether the data is sent to the modmon or not.
          type: boolean
        modelId:
          default: null
          description: 'For a model metric: the ID of the model of related champion/challenger
            to update the metric values.For a deployment metric: the ID of the model
            is not needed.'
          nullable: true
          type: string
        modelPackageId:
          default: null
          description: 'For a model metric: the ID of the model package of related
            champion/challenger to update the metric values.For a deployment metric:
            the ID of the model package is not needed.'
          nullable: true
          type: string
      required:
      - buckets
      - dryRun
      type: object
    MetricValuesOverBatchBucket:
      properties:
        batch:
          $ref: '#/components/schemas/BucketBatch'
          description: Describes a batch associated with the bucket.
          x-versionadded: v2.33
        sampleSize:
          description: Total number of values aggregated in the bucket.
          nullable: true
          type: integer
          x-versionadded: v2.33
        value:
          description: Aggregated custom metric value in the bucket.
          nullable: true
          type: number
          x-versionadded: v2.33
      required:
      - batch
      - sampleSize
      - value
      type: object
    MetricValuesOverBatchResponse:
      properties:
        buckets:
          description: A list of bucketed batches and the custom metric values aggregated
            over that batches.
          items:
            $ref: '#/components/schemas/MetricValuesOverBatchBucket'
          maxItems: 100
          type: array
          x-versionadded: v2.33
        metric:
          $ref: '#/components/schemas/MetricEntity'
          description: A custom metric definition.
          x-versionadded: v2.33
      required:
      - buckets
      - metric
      type: object
    MetricValuesOverTimeBucket:
      properties:
        period:
          $ref: '#/components/schemas/MetricPeriodBucket'
          description: A time period defined by a start and end time
        sampleSize:
          description: Total number of values aggregated in the bucket.
          nullable: true
          type: integer
        value:
          description: Aggregated custom metric value in the bucket.
          nullable: true
          type: number
      required:
      - period
      - sampleSize
      - value
      type: object
    MetricValuesOverTimeResponse:
      properties:
        buckets:
          description: A list of bucketed time periods and the custom metric values
            aggregated over that period.
          items:
            $ref: '#/components/schemas/MetricValuesOverTimeBucket'
          maxItems: 100
          type: array
        metric:
          $ref: '#/components/schemas/MetricEntity'
          description: A custom metric definition.
        summary:
          $ref: '#/components/schemas/MetricValuesOverTimeSummary'
          description: Summary of values over time retrieval.
      required:
      - buckets
      - metric
      - summary
      type: object
    MetricValuesOverTimeSummary:
      properties:
        end:
          description: End of the retrieval range.
          format: date-time
          type: string
        start:
          description: Start of the retrieval range.
          format: date-time
          type: string
      required:
      - end
      - start
      type: object
    MissingReportRetrieve:
      properties:
        missingValuesReport:
          description: Missing values report, which contains an array of reports for
            individual features
          items:
            $ref: '#/components/schemas/PerFeatureMissingReport'
          type: array
      required:
      - missingValuesReport
      type: object
    MlpkgFileContents:
      properties:
        allTimeSeriesPredictionIntervals:
          description: Whether .mlpkg contains TS prediction intervals computed for
            all percentiles
          nullable: true
          type: boolean
          x-versionadded: v2.31
      type: object
    ModelAdvancedTuning:
      properties:
        tuningDescription:
          description: Human-readable description of this advanced-tuning request.
          type: string
        tuningParameters:
          description: Parameters to tune.
          items:
            $ref: '#/components/schemas/TuningParameter'
          type: array
      required:
      - tuningParameters
      type: object
    ModelCapabilitiesRetrieveResponse:
      properties:
        eligibleForPrime:
          description: '`True` if the model is eligible for prime. Use :http:get:`/api/v2/projects/(projectId)/models/(modelId)/primeInfo/`
            to request additional details if the model is not eligible.'
          type: boolean
        hasParameters:
          description: '`True` if the model has parameters that can be retrieved.
            Use :http:get:`/api/v2/projects/(projectId)/models/(modelId)/parameters/`
            to retrieve the model parameters.'
          type: boolean
        hasWordCloud:
          description: True` if the model has word cloud data available. Use :http:get:`/api/v2/projects/(projectId)/models/(modelId)/wordCloud/`
            to retrieve a word cloud.
          type: boolean
        reasons:
          $ref: '#/components/schemas/Reasons'
          description: Information on why capability is unsupported for the model.
        supportsBlending:
          description: '`True` if the model supports blending. See :http:post:`/api/v2/projects/(projectId)/blenderModels/blendCheck/`
            to check specific blending combinations.'
          type: boolean
        supportsCodeGeneration:
          description: '`True` if the model supports export of model''s source code
            or compiled Java executable.'
          type: boolean
          x-versionadded: v2.18
        supportsCoefficients:
          description: '`True` if model coefficients are available.'
          type: boolean
          x-versionadded: v2.32
        supportsConfusionMatrix:
          description: '`True` if Confusion Matrix can be generated.'
          type: boolean
          x-versionadded: v2.33
        supportsDocumentTextExtractionSampleInsight:
          description: '`True` if the model has document column(s) and document text
            extraction samples can be generated.'
          type: boolean
          x-versionadded: v2.29
        supportsEarlyStopping:
          description: '`True` if this is an early stopping tree-based model and number
            of trained iterations can be retrieved.'
          type: boolean
          x-versionadded: v2.22
        supportsImageActivationMaps:
          description: '`True` if the model has image column(s) and activation maps
            can be generated.'
          type: boolean
          x-versionadded: v2.19
        supportsImageEmbedding:
          description: '`True` if the model has image column(s) and image embeddings
            can be generated.'
          type: boolean
          x-versionadded: v2.19
        supportsLiftChart:
          description: '`True` if Lift Chart can be generated.'
          type: boolean
          x-versionadded: v2.31
        supportsModelPackageExport:
          description: '`True` if the model can be exported as a model package.'
          type: boolean
          x-versionadded: v2.19
        supportsModelTrainingMetrics:
          description: When `True` , the model will track and save key training metrics
            in an effort to communicate model accuracy throughout training, rather
            than at training completion.
          type: boolean
          x-versionadded: v2.21
        supportsMonotonicConstraints:
          description: '`True` if the model supports monotonic  constraints.'
          type: boolean
        supportsNNVisualizations:
          description: '`True` if the model supports neuralNetworkVisualizations.'
          type: boolean
          x-versionadded: v2.19
        supportsResiduals:
          description: When `True`, the model supports residuals and residuals data
            can be retrieved.
          type: boolean
          x-versionadded: v2.30
        supportsRocCurve:
          description: '`True` if ROC Curve can be generated.'
          type: boolean
          x-versionadded: v2.32
        supportsShap:
          description: '`True` if the model supports Shapley package. i.e. Shapley
            based feature Importance'
          type: boolean
          x-versionadded: v2.18
      required:
      - eligibleForPrime
      - hasParameters
      - hasWordCloud
      - supportsBlending
      - supportsCodeGeneration
      - supportsCoefficients
      - supportsConfusionMatrix
      - supportsDocumentTextExtractionSampleInsight
      - supportsImageActivationMaps
      - supportsImageEmbedding
      - supportsLiftChart
      - supportsModelTrainingMetrics
      - supportsMonotonicConstraints
      - supportsNNVisualizations
      - supportsResiduals
      - supportsRocCurve
      - supportsShap
      type: object
    ModelComplianceDocsInitializationsResponse:
      properties:
        initialized:
          description: Whether compliance documentation pre-preprocessing is initialized
            for the model
          type: boolean
        status:
          description: Compliance documentation pre-processing initialization status
          enum:
          - initialized
          - initializationInProgress
          - notRequested
          - noTrainingData
          - trainingDataAssignmentInProgress
          - initializationError
          type: string
      required:
      - initialized
      - status
      type: object
    ModelConfusionChartClassDetailsForDatasetRetrieve:
      properties:
        actualFrequency:
          description: One vs All actual percentage and count in a format specified
            below sorted by percentage in decreasing order
          items:
            $ref: '#/components/schemas/ActualFrequency'
          type: array
        className:
          description: Name of a class for which distribution frequency is requested
          type: string
        datasetId:
          description: The dataset to retrieve a Confusion chart from.
          type: string
        modelId:
          description: The model to retrieve a Confusion chart from.
          type: string
        predictedFrequency:
          description: One vs All predicted percentage and count in a format specified
            below sorted by percentage in decreasing order
          items:
            $ref: '#/components/schemas/PredictedFrequency'
          type: array
        projectId:
          description: The project to retrieve a Confusion chart from.
          type: string
      required:
      - actualFrequency
      - className
      - datasetId
      - modelId
      - predictedFrequency
      - projectId
      type: object
    ModelConfusionChartClassDetailsRetrieveReponseController:
      properties:
        actualFrequency:
          description: One vs all actual percentage and count in a format specified
            below sorted by percentage in decreasing order
          items:
            $ref: '#/components/schemas/ActualFrequency'
          type: array
        className:
          description: Name of a class for which distribution frequency is requested.
          type: string
        predictedFrequency:
          description: One vs all predicted percentage and count in a format specified
            below sorted by percentage in decreasing order
          items:
            $ref: '#/components/schemas/PredictedFrequency'
          type: array
      required:
      - actualFrequency
      - className
      - predictedFrequency
      type: object
    ModelConfusionChartListResponse:
      properties:
        charts:
          description: Chart data from all available sources.
          items:
            $ref: '#/components/schemas/ModelConfusionChartRetrieveResponse'
          type: array
      required:
      - charts
      type: object
    ModelConfusionChartMetadataRetrieveResponse:
      properties:
        classNames:
          description: List of all class names in the full confusion matrix, sorted
            by the `orderBy` parameter
          items:
            type: string
          type: array
        globalMetrics:
          $ref: '#/components/schemas/GlobalMetrics'
          description: average metrics across all classes
        relevantClassesPositions:
          description: Matrix to highlight important cell blocks in the confusion
            chart.  Intended to represent a thumbnail view, where the relevantClassesPositions
            array has a 1 in thumbnail cells that are of interest, and 0 otherwise.  The
            dimensions of the implied thumbnail will not match those of the confusion
            matrix, e.g. a twenty-class confusion matrix may have a 2x2 thumbnail.
          items:
            items:
              maximum: 1
              minimum: 0
              type: integer
            type: array
          type: array
        source:
          description: Source of the chart.
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
        totalMatrixSum:
          description: Sum of all values in the full confusion matrix (equal to the
            number of points considered)
          minimum: 0
          type: integer
      required:
      - classNames
      - globalMetrics
      - relevantClassesPositions
      - source
      - totalMatrixSum
      type: object
    ModelConfusionChartRetrieveResponse:
      properties:
        columns:
          description: '[colStart, colEnd] column dimension of confusion matrix in
            response'
          items:
            type: integer
          type: array
        data:
          $ref: '#/components/schemas/ConfusionChartData'
          description: confusion chart data with the format below.
        globalMetrics:
          $ref: '#/components/schemas/GlobalMetrics'
          description: average metrics across all classes
        numberOfClasses:
          description: count of classes in full confusion matrix.
          type: integer
        rows:
          description: '[rowStart, rowEnd] row dimension of confusion matrix in response'
          items:
            type: integer
          type: array
        source:
          description: source of the chart
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
        totalMatrixSum:
          description: sum of all values in full confusion matrix
          type: integer
      required:
      - columns
      - data
      - globalMetrics
      - numberOfClasses
      - rows
      - source
      - totalMatrixSum
      type: object
    ModelDetailsResponse:
      properties:
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
        dataSelectionMethod:
          description: Identifies which setting defines the training size of the model
            when making predictions and scoring. Only used by datetime models.
          enum:
          - duration
          - rowCount
          - selectedDateRange
          - useProjectSettings
          type: string
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        id:
          description: the ID of the model
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
        isNClustersDynamicallyDetermined:
          description: Whether number of clusters is dynamically determined. Only
            valid in unsupervised clustering projects.
          type: boolean
        isStarred:
          description: whether the model has been starred
          type: boolean
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          description: Object returning model lifecycle.
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          nullable: true
          type: string
          x-versionadded: v2.21
        metrics:
          description: the performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or null if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
        modelFamily:
          description: the family model belongs to, e.g. SVM, GBM, etc.
          type: string
          x-versionadded: v2.21
        modelFamilyFullName:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.31
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
        monotonicDecreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        monotonicIncreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          nullable: true
          type: integer
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
        predictionThreshold:
          description: threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.13
        predictionThresholdReadOnly:
          description: indicates whether modification of a predictions threshold is
            forbidden. Since v2.22 threshold modification is allowed.
          type: boolean
          x-versionadded: v2.13
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
        projectId:
          description: the ID of the project to which the model belongs
          type: string
        samplePct:
          description: the percentage of the dataset used in training the model
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: number
        samplingMethod:
          description: indicates sampling method used to select training data in datetime
            models. For row-based project this is the way how requested number of
            rows are selected.For other projects (duration-based, start/end, project
            settings) - how specified percent of rows (timeWindowSamplePct) is selected
            from specified time window.
          enum:
          - random
          - latest
          type: string
        supportsComposableMl:
          description: indicates whether this model is supported in Composable ML.
          type: boolean
          x-versionadded: '2.26'
        supportsMonotonicConstraints:
          description: whether this model supports enforcing monotonic constraints
          type: boolean
          x-versionadded: v2.21
        timeWindowSamplePct:
          description: An integer between 1 and 99, indicating the percentage of sampling
            within the time window. The points kept are determined by samplingMethod
            option. Will be null if no sampling was specified. Only used by datetime
            models.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          nullable: true
          type: string
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          nullable: true
          type: string
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          nullable: true
          type: string
      required:
      - blueprintId
      - featurelistId
      - featurelistName
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - lifecycle
      - linkFunction
      - metrics
      - modelCategory
      - modelFamily
      - modelFamilyFullName
      - modelNumber
      - modelType
      - monotonicDecreasingFeaturelistId
      - monotonicIncreasingFeaturelistId
      - parentModelId
      - predictionThreshold
      - predictionThresholdReadOnly
      - processes
      - projectId
      - samplePct
      - supportsComposableMl
      - supportsMonotonicConstraints
      - trainingDuration
      - trainingEndDate
      - trainingRowCount
      - trainingStartDate
      type: object
    ModelFeatureListResponse:
      properties:
        aPrioriFeatureNames:
          description: (Deprecated in version v2.11) Renamed to `knownInAdvanceFeatureNames`.
            This parameter always has the same value as `knownInAdvanceFeatureNames`
            and will be removed in a future release.
          items:
            type: string
          type: array
        featureNames:
          description: An array of the names of all features used by the specified
            model.
          items:
            type: string
          type: array
        knownInAdvanceFeatureNames:
          description: An array of the names of time series known-in-advance features
            used by the specified model.
          items:
            type: string
          type: array
      required:
      - aPrioriFeatureNames
      - featureNames
      - knownInAdvanceFeatureNames
      type: object
    ModelJobResponse:
      properties:
        blueprintId:
          description: The blueprint used by the model - note that this is not an
            ObjectId.
          type: string
        featurelistId:
          description: The ID of the featurelist the model is using.
          type: string
        id:
          description: The job ID.
          type: string
        isBlocked:
          description: True if a job is waiting for its dependencies to be resolved
            first.
          type: boolean
        isTrainedOnGpu:
          description: True if the job was trained using GPU capabilities
          type: boolean
        modelCategory:
          description: Indicates what kind of model this is. Will be ``combined``
            for combined models.
          enum:
          - model
          - prime
          - blend
          type: string
        modelId:
          description: The ID of the model
          type: string
        modelType:
          description: The type of model used by the job.
          type: string
        processes:
          description: List of processes the modeling job includes
          items:
            type: string
          type: array
        projectId:
          description: The project the job belongs to.
          type: string
        samplePct:
          description: The percentage of the dataset the job is using.
          type: number
        status:
          description: The status of the job.
          enum:
          - queue
          - inprogress
          - error
          - ABORTED
          - COMPLETED
          type: string
      required:
      - blueprintId
      - featurelistId
      - id
      - isBlocked
      - modelCategory
      - modelId
      - modelType
      - processes
      - projectId
      - status
      type: object
    ModelLifecycle:
      properties:
        reason:
          description: Reason for lifecycle stage. None if model is active.
          nullable: true
          type: string
          x-versionadded: v2.30
        stage:
          description: Model lifecycle stage.
          enum:
          - active
          - deprecated
          - disabled
          type: string
          x-versionadded: v2.30
      required:
      - reason
      - stage
      type: object
    ModelLiftChartListResponse:
      properties:
        charts:
          description: List of lift chart data from all available sources.
          items:
            $ref: '#/components/schemas/ModelLiftChartResponse'
          type: array
      required:
      - charts
      type: object
    ModelLiftChartResponse:
      properties:
        bins:
          description: The lift chart data for that source, as specified below.
          items:
            $ref: '#/components/schemas/LiftBinResponse'
          type: array
        source:
          description: Source of the data.
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
          x-enum-versionadded:
          - value: backtest_2
            x-versionadded: v2.23
          - value: backtest_3
            x-versionadded: v2.23
          - value: backtest_4
            x-versionadded: v2.23
          - value: backtest_5
            x-versionadded: v2.23
          - value: backtest_6
            x-versionadded: v2.23
          - value: backtest_7
            x-versionadded: v2.23
          - value: backtest_8
            x-versionadded: v2.23
          - value: backtest_9
            x-versionadded: v2.23
          - value: backtest_10
            x-versionadded: v2.23
          - value: backtest_11
            x-versionadded: v2.23
          - value: backtest_12
            x-versionadded: v2.23
          - value: backtest_13
            x-versionadded: v2.23
          - value: backtest_14
            x-versionadded: v2.23
          - value: backtest_15
            x-versionadded: v2.23
          - value: backtest_16
            x-versionadded: v2.23
          - value: backtest_17
            x-versionadded: v2.23
          - value: backtest_18
            x-versionadded: v2.23
          - value: backtest_19
            x-versionadded: v2.23
          - value: backtest_20
            x-versionadded: v2.23
      required:
      - bins
      - source
      type: object
    ModelPackageBiasAndFairness:
      properties:
        fairnessMetricsSet:
          description: A set of fairness metrics to use for calculating fairness.
          enum:
          - proportionalParity
          - equalParity
          - predictionBalance
          - trueFavorableAndUnfavorableRateParity
          - favorableAndUnfavorablePredictiveValueParity
          type: string
        fairnessThreshold:
          description: Threshold value of the fairness metric. Can be in a range of
            ``[0:1]``.
          maximum: 1
          minimum: 0
          type: number
        preferableTargetValue:
          anyOf:
          - type: boolean
          - type: integer
          - type: string
          description: A target value that should be treated as a positive outcome
            for the prediction. For example if we want to check gender discrimination
            for giving a loan and our target named ``is_bad``, then the positive outcome
            for the prediction would be ``No``, meaning that the loan is good and
            that's what we treat as a preferable result for the loaner.
        protectedFeatures:
          description: A list of feature to mark as protected for Bias and Fairness
            measurement. A common example of those would `race`, `gender`, `age_group`.
            All protected features should be tracked as segment attributes. Only categorical
            features can be marked as protected.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - fairnessMetricsSet
      - fairnessThreshold
      - preferableTargetValue
      - protectedFeatures
      type: object
    ModelPackageCapabilities:
      properties:
        supportsAutomaticActuals:
          description: Whether inferring actual values from time series history data
            and automatically feeding them back for accuracy estimation is supported
            by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsChallengerModels:
          description: Whether Challenger Models are supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsFeatureDriftTracking:
          description: Whether Feature Drift is supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsHumilityRecommendedRules:
          description: Whether calculating values for recommended Humility Rules is
            supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsHumilityRules:
          description: Whether Humility Rules are supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsHumilityRulesDefaultCalculations:
          description: Whether calculating default values for Humility Rules is supported
            by this model package.
          type: boolean
          x-versionadded: v2.25.2
        supportsPredictionWarning:
          description: Whether Prediction Warnings are supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsRetraining:
          description: Whether deployment supports retraining.
          type: boolean
          x-versionadded: v2.28
          x-versiondeprecated: v2.29
        supportsScoringCodeDownload:
          description: Whether scoring code download is supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsSecondaryDatasets:
          description: If the deployments supports secondary datasets.
          type: boolean
          x-versionadded: v2.28
          x-versiondeprecated: v2.29
        supportsSegmentedAnalysisDriftAndAccuracy:
          description: Whether tracking features in training and predictions data
            for segmented analysis is supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsShapBasedPredictionExplanations:
          description: Whether shap-based prediction explanations are supported by
            this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        supportsTargetDriftTracking:
          description: Whether Target Drift is supported by this model package.
          type: boolean
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
      required:
      - supportsChallengerModels
      - supportsFeatureDriftTracking
      - supportsHumilityRecommendedRules
      - supportsHumilityRules
      - supportsHumilityRulesDefaultCalculations
      - supportsPredictionWarning
      - supportsSecondaryDatasets
      - supportsSegmentedAnalysisDriftAndAccuracy
      - supportsShapBasedPredictionExplanations
      - supportsTargetDriftTracking
      type: object
    ModelPackageCapabilitiesRetrieveResponse:
      properties:
        data:
          description: List of all capabilities.
          items:
            $ref: '#/components/schemas/ModelPackageCapability'
          type: array
      required:
      - data
      type: object
    ModelPackageCapability:
      properties:
        messages:
          description: Messages explaining why the capability is supported or not
            supported.
          items:
            type: string
          type: array
        name:
          description: The name of the capability.
          type: string
        supported:
          description: If the capability is supported.
          type: boolean
      required:
      - messages
      - name
      - supported
      type: object
    ModelPackageCreateFromLeaderboard:
      properties:
        computeAllTsIntervals:
          default: null
          description: Whether to compute all Time Series prediction intervals (1-100
            percentiles)
          nullable: true
          type: boolean
        description:
          default: ''
          description: Description of the model package.
          maxLength: 2048
          nullable: true
          type: string
        distributionPredictionModelId:
          default: null
          description: ID of the DataRobot distribution prediction model trained on
            predictions from the DataRobot model.
          nullable: true
          type: string
        modelId:
          description: ID of the DataRobot model.
          type: string
        name:
          default: null
          description: Name of the model package.
          maxLength: 512
          nullable: true
          type: string
        predictionThreshold:
          description: Threshold used for binary classification in predictions
          maximum: 1.0
          minimum: 0.0
          type: number
      required:
      - modelId
      type: object
    ModelPackageCreateFromLearningModel:
      properties:
        description:
          description: Description of the model package.
          maxLength: 2048
          nullable: true
          type: string
        distributionPredictionModelId:
          default: null
          description: ID of the DataRobot distribution prediction model trained on
            predictions from the DataRobot model.
          nullable: true
          type: string
        modelId:
          description: ID of the DataRobot model.
          type: string
        name:
          default: null
          description: Name of the model package.
          maxLength: 512
          nullable: true
          type: string
        predictionThreshold:
          description: Threshold used for binary classification in predictions
          maximum: 1.0
          minimum: 0.0
          type: number
      required:
      - modelId
      type: object
    ModelPackageDatasets:
      properties:
        baselineSegmentedBy:
          description: Names of categorical features by which the training baseline
            was segmented. This allows for deployment prediction requests to be segmented
            by those same features. Segmenting the training baseline by these features
            allows for users to perform segmented analysis of Data Drift and Accuracy,
            and to compare the same subset of training and scoring data based on the
            selected segment attribute and segment value.
          items:
            type: string
          nullable: true
          type: array
        datasetName:
          description: Name of dataset used to train the model
          nullable: true
          type: string
        holdoutDataCatalogId:
          description: ID for holdout data (returned from uploading a data set)
          nullable: true
          type: string
        holdoutDataCatalogVersionId:
          description: Version ID for holdout data (returned from uploading a data
            set)
          nullable: true
          type: string
        holdoutDatasetName:
          description: Name of dataset used for model holdout
          nullable: true
          type: string
        targetHistogramBaseline:
          description: Values used to establish the training baseline
          enum:
          - predictions
          - actuals
          type: string
        trainingDataCatalogId:
          description: ID for training data (returned from uploading a data set)
          nullable: true
          type: string
        trainingDataCatalogVersionId:
          description: Version ID for training data (returned from uploading a data
            set)
          nullable: true
          type: string
        trainingDataSize:
          description: Number of rows in training data (used by DR models)
          type: integer
      required:
      - baselineSegmentedBy
      - datasetName
      - holdoutDataCatalogId
      - holdoutDataCatalogVersionId
      - holdoutDatasetName
      - trainingDataCatalogId
      - trainingDataCatalogVersionId
      type: object
    ModelPackageImportMeta:
      properties:
        containsFearPipeline:
          description: Exists for imported models only, indicates thatmodel package
            contains file with fear pipeline.
          nullable: true
          type: boolean
        containsFeaturelists:
          description: Exists for imported models only, indicates thatmodel package
            contains file with featurelists.
          nullable: true
          type: boolean
        containsLeaderboardMeta:
          description: Exists for imported models only, indicates thatmodel package
            contains file with leaderboard meta.
          nullable: true
          type: boolean
        containsProjectMeta:
          description: Exists for imported models only, indicates thatmodel package
            contains file with project meta.
          nullable: true
          type: boolean
        creatorFullName:
          description: Full name of the person who created this model package
          nullable: true
          type: string
        creatorId:
          description: User ID of the person who created this Model Package
          type: string
        creatorUsername:
          description: Username of the person who created this model package
          type: string
        dateCreated:
          description: When this Model Package was created
          type: string
        originalFileName:
          description: Exists for imported models only, the original file name that
            was uploaded
          nullable: true
          type: string
      required:
      - creatorFullName
      - creatorId
      - creatorUsername
      - dateCreated
      - originalFileName
      type: object
    ModelPackageListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: list of formatted model packages
          items:
            $ref: '#/components/schemas/ModelPackageRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ModelPackageModelDescription:
      properties:
        buildEnvironmentType:
          description: build environment type of the model
          enum:
          - DataRobot
          - Python
          - R
          - Java
          - Other
          type: string
        description:
          description: a description of the model
          nullable: true
          type: string
        location:
          description: location of the model
          nullable: true
          type: string
        modelCreatedAt:
          description: time when the model was created
          nullable: true
          type: string
        modelCreatorEmail:
          description: email of the user who created the model
          nullable: true
          type: string
        modelCreatorId:
          default: null
          description: ID of the creator of the model
          nullable: true
          type: string
        modelCreatorName:
          description: name of the user who created the model
          nullable: true
          type: string
        modelName:
          description: model name
          type: string
      required:
      - buildEnvironmentType
      - description
      - location
      type: object
    ModelPackageModelKind:
      properties:
        isAnomalyDetectionModel:
          description: true if this is an anomaly detection model
          type: boolean
        isCombinedModel:
          description: true if model is a combined model
          type: boolean
          x-versionadded: v2.27
        isDecisionFlow:
          description: true if this is a decision flow
          type: boolean
        isFeatureDiscovery:
          description: true if this model uses the Feature Discovery feature
          type: boolean
        isMultiseries:
          description: true if model is multiseries
          type: boolean
        isTimeSeries:
          description: true if model is time series
          type: boolean
        isUnsupervisedLearning:
          description: true if model used unsupervised learning
          type: boolean
      required:
      - isAnomalyDetectionModel
      - isCombinedModel
      - isDecisionFlow
      - isFeatureDiscovery
      - isMultiseries
      - isTimeSeries
      - isUnsupervisedLearning
      type: object
    ModelPackageResponse:
      properties:
        id:
          description: ID of the model package.
          type: string
        name:
          description: Type of the current model.
          type: string
        registeredModelId:
          description: ID of the associated registered model
          nullable: true
          type: string
      required:
      - id
      - name
      type: object
    ModelPackageRetrieveResponse:
      properties:
        activeDeploymentCount:
          description: Number of deployments currently using this model package
          type: integer
        buildStatus:
          description: Model package build status
          enum:
          - inProgress
          - complete
          - failed
          nullable: true
          type: string
        capabilities:
          $ref: '#/components/schemas/ModelPackageCapabilities'
          description: Capabilities of the current model package.
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        datasets:
          $ref: '#/components/schemas/ModelPackageDatasets'
          description: dataset information for the model package
        id:
          description: ID of the Model package
          type: string
        importMeta:
          $ref: '#/components/schemas/ModelPackageImportMeta'
          description: Information from when this Model Package was first saved
        isArchived:
          description: Whether the model package is permanently archived (cannot be
            used in deployment or replacement)
          type: boolean
        isDeprecated:
          description: Whether the model package is deprecated. eg. python2 models
            are deprecated.
          type: boolean
          x-versionadded: v2.29
        mlpkgFileContents:
          $ref: '#/components/schemas/MlpkgFileContents'
          description: Information about the content of .mlpkg artifact
          x-versionadded: v2.31
        modelDescription:
          $ref: '#/components/schemas/ModelPackageModelDescription'
          description: model description information for the model package
        modelExecutionType:
          description: Type of model package. `dedicated` (native DataRobot models)
            and `custom_inference_model` (user added inference models) both execute
            on DataRobot prediction servers, `external` do not
          enum:
          - dedicated
          - custom_inference_model
          - external
          type: string
        modelId:
          description: ID of the model
          type: string
        modelKind:
          $ref: '#/components/schemas/ModelPackageModelKind'
          description: Model attribute information
        name:
          description: Model package name
          type: string
        permissions:
          description: List of action permissions the user making the request has
            on the model package
          items:
            type: string
          type: array
          x-versionadded: v2.20
        sourceMeta:
          $ref: '#/components/schemas/ModelPackageSourceMeta'
          description: Meta information from where this model was generated
        target:
          $ref: '#/components/schemas/ModelPackageTarget'
          description: target information for the model package
        timeseries:
          $ref: '#/components/schemas/ModelPackageTimeseries'
          description: time series information for the model package
        updatedBy:
          $ref: '#/components/schemas/UserMetadata'
          description: Information on the user who last modified the registered model
          nullable: true
        userProvidedId:
          description: A user-provided unique ID associated with the given custom
            inference model.
          type: string
      required:
      - activeDeploymentCount
      - capabilities
      - datasets
      - id
      - importMeta
      - isArchived
      - isDeprecated
      - modelDescription
      - modelExecutionType
      - modelId
      - modelKind
      - name
      - permissions
      - sourceMeta
      - target
      - timeseries
      - updatedBy
      type: object
    ModelPackageRetrieveResponseBase:
      properties:
        buildStatus:
          description: Model package build status
          enum:
          - inProgress
          - complete
          - failed
          nullable: true
          type: string
          x-versionadded: v2.33
        capabilities:
          $ref: '#/components/schemas/ModelPackageCapabilities'
          description: Capabilities of the current model package.
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        datasets:
          $ref: '#/components/schemas/ModelPackageDatasets'
          description: dataset information for the model package
          x-versionadded: v2.33
        id:
          description: ID of the Model package
          type: string
          x-versionadded: v2.33
        importMeta:
          $ref: '#/components/schemas/ModelPackageImportMeta'
          description: Information from when this Model Package was first saved
          x-versionadded: v2.33
        isArchived:
          description: Whether the model package is permanently archived (cannot be
            used in deployment or replacement)
          type: boolean
          x-versionadded: v2.33
        isDeprecated:
          description: Whether the model package is deprecated. eg. python2 models
            are deprecated.
          type: boolean
          x-versionadded: v2.29
        mlpkgFileContents:
          $ref: '#/components/schemas/MlpkgFileContents'
          description: Information about the content of .mlpkg artifact
          x-versionadded: v2.31
        modelDescription:
          $ref: '#/components/schemas/ModelPackageModelDescription'
          description: model description information for the model package
          x-versionadded: v2.33
        modelExecutionType:
          description: Type of model package. `dedicated` (native DataRobot models)
            and `custom_inference_model` (user added inference models) both execute
            on DataRobot prediction servers, `external` do not
          enum:
          - dedicated
          - custom_inference_model
          - external
          type: string
          x-versionadded: v2.33
        modelId:
          description: ID of the model
          type: string
          x-versionadded: v2.33
        modelKind:
          $ref: '#/components/schemas/ModelPackageModelKind'
          description: Model attribute information
          x-versionadded: v2.33
        name:
          description: Model package name
          type: string
          x-versionadded: v2.33
        sourceMeta:
          $ref: '#/components/schemas/ModelPackageSourceMeta'
          description: Meta information from where this model was generated
          x-versionadded: v2.33
        target:
          $ref: '#/components/schemas/ModelPackageTarget'
          description: target information for the model package
          x-versionadded: v2.33
        timeseries:
          $ref: '#/components/schemas/ModelPackageTimeseries'
          description: time series information for the model package
          x-versionadded: v2.33
        updatedBy:
          $ref: '#/components/schemas/UserMetadata'
          description: Information on the user who last modified the registered model
          nullable: true
          x-versionadded: v2.33
        userProvidedId:
          description: A user-provided unique ID associated with the given custom
            inference model.
          type: string
          x-versionadded: v2.33
      required:
      - capabilities
      - datasets
      - id
      - importMeta
      - isArchived
      - isDeprecated
      - modelDescription
      - modelExecutionType
      - modelId
      - modelKind
      - name
      - sourceMeta
      - target
      - timeseries
      - updatedBy
      type: object
    ModelPackageScoringCodeMeta:
      properties:
        dataRobotPredictionVersion:
          description: DataRobot prediction API version for the scoring code
          nullable: true
          type: string
        location:
          description: Location of the scoring code
          enum:
          - local_leaderboard
          - mlpkg
          nullable: true
          type: string
      required:
      - dataRobotPredictionVersion
      - location
      type: object
    ModelPackageSourceMeta:
      properties:
        decisionFlowId:
          description: The ID of the flow associated with this model package
          nullable: true
          type: string
        decisionFlowVersionId:
          description: The version ID of the flow associated with this model package
          nullable: true
          type: string
        environmentUrl:
          description: If available, URL of the source model
          format: uri
          nullable: true
          type: string
        fips_140_2Enabled:
          description: true if the model was built with FIPS-140-2
          type: boolean
        projectCreatedAt:
          description: If available, time when the project was created
          nullable: true
          type: string
        projectCreatorEmail:
          description: If available, email of the user who created the project
          nullable: true
          type: string
        projectCreatorId:
          default: null
          description: If available, ID of the creator of the project
          nullable: true
          type: string
        projectCreatorName:
          description: If available, name of the user who created the project
          nullable: true
          type: string
        projectId:
          description: If available, the project id used for this model
          nullable: true
          type: string
        projectName:
          description: If available, the project name for this model
          nullable: true
          type: string
        scoringCode:
          $ref: '#/components/schemas/ModelPackageScoringCodeMeta'
          description: If available, information about the model's scoring code
          nullable: true
        useCaseDetails:
          $ref: '#/components/schemas/UseCaseDetails'
          description: Details of the use-case associated to this registered model
            version
          nullable: true
      required:
      - decisionFlowId
      - decisionFlowVersionId
      - environmentUrl
      - projectId
      - projectName
      - scoringCode
      type: object
    ModelPackageTarget:
      properties:
        classCount:
          description: Number of classes for classification models.
          minimum: 0
          nullable: true
          type: integer
        classNames:
          description: Class names for prediction results. When target type is Binary,
            two class names are returned. The first element is the minority (positive)
            class and the second element is the majority (negative) class. Limited
            to 100 returned for Multiclass.
          items:
            type: string
          maxItems: 100
          nullable: true
          type: array
        name:
          description: name of the target column
          type: string
        predictionProbabilitiesColumn:
          description: Field or column name containing prediction probabilities
          nullable: true
          type: string
        predictionThreshold:
          description: Prediction threshold used for binary classification models
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        type:
          description: Target type of the model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Multilabel
          - TextGeneration
          type: string
      required:
      - classCount
      - classNames
      - name
      - predictionProbabilitiesColumn
      - predictionThreshold
      - type
      type: object
    ModelPackageTimeseries:
      properties:
        datetimeColumnFormat:
          description: Date format for forecast date and forecast point column
          nullable: true
          type: string
        datetimeColumnName:
          description: Name of the forecast date column
          nullable: true
          type: string
        effectiveFeatureDerivationWindowEnd:
          description: Same concept as `featureDerivationWindowEnd` which is chosen
            by the user and based on the initial sampled data from the eda sample.
            When the dataset goes through aim, the pipeline reads the full dataset
            and figures out the "real" FDW (i.e., the effective FDW). For most models,
            eFDW is approximately the same as the FDW.
          maximum: 0
          nullable: true
          type: integer
          x-versionadded: v2.25
        effectiveFeatureDerivationWindowStart:
          description: Same concept as `featureDerivationWindowStart` which is chosen
            by the user and based on the initial sampled data from the eda sample.
            When the dataset goes through aim, the pipeline reads the full dataset
            and figures out the "real" FDW (i.e., the effective FDW). For most models,
            eFDW is approximately the same as the FDW.
          maximum: 0
          nullable: true
          type: integer
          x-versionadded: v2.25
        featureDerivationWindowEnd:
          description: Negative number or zero defining how many time units of the
            forecast distances time unit into the past relative to the forecast point
            the feature derivation window should end.
          maximum: 0
          nullable: true
          type: integer
        featureDerivationWindowStart:
          description: Negative number or zero defining how many time units of the
            forecast distances time unit into the past relative to the forecast point
            the feature derivation window should begin.
          maximum: 0
          nullable: true
          type: integer
        forecastDistanceColumnName:
          description: Name of the forecast distance column
          nullable: true
          type: string
        forecastDistances:
          description: List of integer forecast distances
          items:
            type: integer
          nullable: true
          type: array
        forecastDistancesTimeUnit:
          description: The time unit of forecast distances
          enum:
          - MICROSECOND
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          nullable: true
          type: string
        forecastPointColumnName:
          description: Name of the forecast point column
          nullable: true
          type: string
        isCrossSeries:
          description: true if the model is cross-series.
          nullable: true
          type: boolean
        isNewSeriesSupport:
          description: true if the model is optimized to support new series.
          nullable: true
          type: boolean
          x-versionadded: v2.25
        isTraditionalTimeSeries:
          description: true if the model is traditional time series.
          nullable: true
          type: boolean
        seriesColumnName:
          description: Name of the series column in case of multi-series date
          nullable: true
          type: string
      required:
      - datetimeColumnFormat
      - datetimeColumnName
      - effectiveFeatureDerivationWindowEnd
      - effectiveFeatureDerivationWindowStart
      - featureDerivationWindowEnd
      - featureDerivationWindowStart
      - forecastDistanceColumnName
      - forecastDistances
      - forecastDistancesTimeUnit
      - forecastPointColumnName
      - isCrossSeries
      - isNewSeriesSupport
      - isTraditionalTimeSeries
      - seriesColumnName
      type: object
    ModelParametersRetrieveResponse:
      properties:
        derivedFeatures:
          description: An array of preprocessing information about derived features
            used in the model.
          items:
            $ref: '#/components/schemas/DerivedFeatures'
          type: array
        parameters:
          description: An array of parameters that are related to the whole model.
          items:
            $ref: '#/components/schemas/Parameters'
          type: array
      required:
      - derivedFeatures
      - parameters
      type: object
    ModelRecordResponse:
      properties:
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
          x-versionadded: v2.33
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
          x-versionadded: v2.33
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: the ID of the model
          type: string
          x-versionadded: v2.33
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
          x-versionadded: v2.33
        isStarred:
          description: whether the model has been starred
          type: boolean
          x-versionadded: v2.33
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
          x-versionadded: v2.33
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
          x-versionadded: v2.33
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        metrics:
          description: the performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or null if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
          x-versionadded: v2.33
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
          x-versionadded: v2.33
        modelFamily:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.33
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.33
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
          x-versionadded: v2.33
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
          x-versionadded: v2.33
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
          x-versionadded: v2.33
        projectId:
          description: the ID of the project to which the model belongs
          type: string
          x-versionadded: v2.33
        samplePct:
          description: the percentage of the dataset used in training the model
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: number
          x-versionadded: v2.33
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
          x-versionadded: v2.33
      required:
      - blueprintId
      - featurelistId
      - featurelistName
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - metrics
      - modelCategory
      - modelFamily
      - modelNumber
      - modelType
      - parentModelId
      - processes
      - projectId
      - samplePct
      - trainingRowCount
      type: object
    ModelRecordsResponse:
      properties:
        count:
          description: The number of models returned on this page.
          minimum: 0
          type: integer
          x-versionadded: v2.33
        data:
          description: Model records.
          items:
            oneOf:
            - $ref: '#/components/schemas/ModelRecordResponse'
            - $ref: '#/components/schemas/DatetimeModelRecordResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: Total number of models after filters applied.
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ModelReplacementSubmission:
      properties:
        modelId:
          description: ID of the model used to replace deployment's champion model.
            Required if modelPackageId is not provided.
          type: string
          x-versiondeprecated: v2.33
        modelPackageId:
          description: ID of the model package used to replace deployment's champion
            model. Required if modelId is not provided.
          type: string
          x-versionadded: v2.21
        reason:
          description: Reason for the model replacement.
          enum:
          - ACCURACY
          - DATA_DRIFT
          - ERRORS
          - SCHEDULED_REFRESH
          - SCORING_SPEED
          - DEPRECATION
          - OTHER
          type: string
      required:
      - reason
      type: object
    ModelReplacementValidationRequest:
      properties:
        modelId:
          description: ID of the model used to replace deployment's champion model.
            Required if modelPackageId is not provided.
          type: string
          x-versiondeprecated: v2.33
        modelPackageId:
          description: ID of the model package used to replace deployment's champion
            model. Required if modelId is not provided.
          type: string
          x-versionadded: v2.21
      type: object
    ModelReplacementValidationResponse:
      properties:
        checks:
          $ref: '#/components/schemas/ValidationChecks'
          description: A more granular explanation of why the replacement model was
            eligible or ineligible.
        message:
          description: Message of the overall validation check.
          type: string
        status:
          description: Status of the overall validation check.
          enum:
          - failing
          - passing
          - warning
          type: string
      required:
      - checks
      - message
      - status
      type: object
    ModelResidualsChartData:
      properties:
        coefficientOfDetermination:
          description: Also known as the r-squared value. This value is calculated
            over the downsampled dataset, not the full input
          type: number
        data:
          description: 'The rows of chart data in [actual, predicted, residual, row
            number] form. If the row number was not available at the time of model
            creation, the row number will be null. **NOTE**: In DataRobot v5.2, the
            row number will not be included.'
          items:
            items:
              type: number
            maxItems: 4
            type: array
          type: array
        histogram:
          description: Data to plot a histogram of residual values
          items:
            $ref: '#/components/schemas/ModelResidualsHistogram'
          type: array
          x-versionadded: v2.19
        residualMean:
          description: The arithmetic mean of the predicted value minus the actual
            value over the downsampled dataset
          type: number
        standardDeviation:
          description: A measure of deviation from the group as a whole
          type: number
          x-versionadded: v2.19
      required:
      - coefficientOfDetermination
      - data
      - histogram
      - residualMean
      - standardDeviation
      type: object
    ModelResidualsHistogram:
      properties:
        intervalEnd:
          description: The interval end. For all but the last interval, the end value
            is exclusive
          type: number
        intervalStart:
          description: The interval start
          type: number
        occurrences:
          description: The number of times the predicted value fits within the interval
          type: integer
      required:
      - intervalEnd
      - intervalStart
      - occurrences
      type: object
    ModelResidualsList:
      properties:
        residuals:
          $ref: '#/components/schemas/ModelResidualsSource'
          description: Residuals chart data from all available sources
      required:
      - residuals
      type: object
    ModelResidualsSource:
      properties:
        crossValidation:
          $ref: '#/components/schemas/ModelResidualsChartData'
          description: Chart data from the cross validation data source
        holdout:
          $ref: '#/components/schemas/ModelResidualsChartData'
          description: Chart data from the holdout data source
        validation:
          $ref: '#/components/schemas/ModelResidualsChartData'
          description: Chart data from the validation data source
      type: object
    ModelResponse:
      properties:
        datasetName:
          description: Name of dataset used to train challenger model
          type: string
        description:
          description: Description of the model.
          type: string
        executionType:
          description: Type of the current model.
          type: string
        id:
          description: ID of the current model.
          type: string
        isDeprecated:
          description: Whether the current model is deprecated model. eg. python2
            based model.
          type: boolean
          x-versionadded: v2.29
        name:
          description: Name of the model.
          type: string
        projectId:
          description: Project ID of the current model.
          type: string
        projectName:
          description: Project name of the current model.
          type: string
      required:
      - datasetName
      - description
      - executionType
      - id
      - isDeprecated
      - name
      - projectId
      - projectName
      type: object
    ModelRetrainResponse:
      properties:
        message:
          description: any extended message to include about the result. For example,
            if a job is submitted that is a duplicate of a job that has already been
            added to the queue, the message will mention that no new job was created.
          type: string
      required:
      - message
      type: object
    ModelRocCurveListResponse:
      properties:
        charts:
          description: List of ROC curve data from all available sources.
          items:
            $ref: '#/components/schemas/ModelRocCurveResponse'
          type: array
      required:
      - charts
      type: object
    ModelRocCurveResponse:
      properties:
        auc:
          description: AUC value
          nullable: true
          type: number
        kolmogorovSmirnovMetric:
          description: Kolmogorov-Smirnov metric value
          nullable: true
          type: number
        negativeClassPredictions:
          description: List of example predictions for the negative class.
          items:
            description: An example prediction.
            type: number
          type: array
        positiveClassPredictions:
          description: List of example predictions for the positive class.
          items:
            description: An example prediction.
            type: number
          type: array
        rocPoints:
          description: The ROC curve data for that source, as specified below.
          items:
            $ref: '#/components/schemas/RocPointsResponse'
          type: array
        source:
          description: Source of the data.
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
          x-enum-versionadded:
          - value: backtest_2
            x-versionadded: v2.23
          - value: backtest_3
            x-versionadded: v2.23
          - value: backtest_4
            x-versionadded: v2.23
          - value: backtest_5
            x-versionadded: v2.23
          - value: backtest_6
            x-versionadded: v2.23
          - value: backtest_7
            x-versionadded: v2.23
          - value: backtest_8
            x-versionadded: v2.23
          - value: backtest_9
            x-versionadded: v2.23
          - value: backtest_10
            x-versionadded: v2.23
          - value: backtest_11
            x-versionadded: v2.23
          - value: backtest_12
            x-versionadded: v2.23
          - value: backtest_13
            x-versionadded: v2.23
          - value: backtest_14
            x-versionadded: v2.23
          - value: backtest_15
            x-versionadded: v2.23
          - value: backtest_16
            x-versionadded: v2.23
          - value: backtest_17
            x-versionadded: v2.23
          - value: backtest_18
            x-versionadded: v2.23
          - value: backtest_19
            x-versionadded: v2.23
          - value: backtest_20
            x-versionadded: v2.23
      required:
      - auc
      - kolmogorovSmirnovMetric
      - negativeClassPredictions
      - positiveClassPredictions
      - rocPoints
      - source
      type: object
    ModelUpdate:
      properties:
        isStarred:
          description: Mark model either as starred or unstarred.
          type: boolean
        predictionThreshold:
          description: Threshold used for binary classification in predictions. Default
            value is 0.5.
          maximum: 1.0
          minimum: 0.0
          type: number
      type: object
    ModelXrayMetadataDatetimeDataResponse:
      properties:
        backtestIndex:
          description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
            `startstop`.'
          type: string
        sources:
          description: List of sources available for the model.
          items:
            enum:
            - training
            - validation
            - holdout
            type: string
          type: array
        status:
          description: Status of the job.
          enum:
          - INPROGRESS
          - COMPLETED
          - NOT_COMPLETED
          type: string
      required:
      - backtestIndex
      - sources
      - status
      type: object
    ModelXrayMetadataDatetimeResponse:
      properties:
        data:
          description: List of objects with status and sources of each backtest.
          items:
            $ref: '#/components/schemas/ModelXrayMetadataDatetimeDataResponse'
          type: array
      required:
      - data
      type: object
    ModelXrayMetadataResponse:
      properties:
        sources:
          description: List of sources available for the model.
          items:
            enum:
            - training
            - validation
            - holdout
            type: string
          type: array
        status:
          description: Status of the job.
          enum:
          - INPROGRESS
          - COMPLETED
          - NOT_COMPLETED
          type: string
      required:
      - sources
      - status
      type: object
    ModelingFeatureListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Modeling features data.
          items:
            $ref: '#/components/schemas/ModelingFeatureResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ModelingFeatureResponse:
      properties:
        dataQualities:
          description: Data Quality Status
          enum:
          - ISSUES_FOUND
          - NOT_ANALYZED
          - NO_ISSUES_FOUND
          type: string
        dateFormat:
          description: the date format string for how this feature was interpreted
            (or null if not a date feature).  If not null, it will be compatible with
            https://docs.python.org/2/library/time.html#time.strftime .
          nullable: true
          type: string
          x-versionadded: v2.5
        featureLineageId:
          description: id of a lineage for automatically generated features.
          nullable: true
          type: string
          x-versionadded: v2.21
        featureType:
          description: Feature type.
          enum:
          - Boolean
          - Categorical
          - Currency
          - Date
          - Date Duration
          - Document
          - Image
          - Interaction
          - Length
          - Location
          - Multicategorical
          - Numeric
          - Percentage
          - Summarized Categorical
          - Text
          - Time
          type: string
        importance:
          description: numeric measure of the strength of relationship between the
            feature and target (independent of any model or other features)
          nullable: true
          type: number
        isRestoredAfterReduction:
          description: Whether feature is restored after feature reduction
          type: boolean
          x-versionadded: v2.26
        isZeroInflated:
          description: Whether feature has an excessive number of zeros
          nullable: true
          type: boolean
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            description: For a Summarized Categorical columns, this will contain statistics
              for the top 50 keys (truncated to 103 characters)
            x-versionadded: v2.18
          - description: For a Multicategorical columns, this will contain statistics
              for the top classes
            items:
              $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorMultilabel'
            type: array
            x-versionadded: v2.24
        language:
          description: Feature's detected language.
          type: string
          x-versionadded: v2.32
        lowInformation:
          description: whether feature has too few values to be informative
          type: boolean
        max:
          description: maximum value of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: maximum value of the EDA sample of the feature.
            type: string
          - description: maximum value of the EDA sample of the feature.
            type: number
        mean:
          description: arithmetic mean of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: arithmetic mean of the EDA sample of the feature.
            type: string
          - description: arithmetic mean of the EDA sample of the feature.
            type: number
        median:
          description: median of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: median of the EDA sample of the feature.
            type: string
          - description: median of the EDA sample of the feature.
            type: number
        min:
          description: minimum value of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: minimum value of the EDA sample of the feature.
            type: string
          - description: minimum value of the EDA sample of the feature.
            type: number
        multilabelInsights:
          $ref: '#/components/schemas/MultilabelInsightsResponse'
          description: Multilabel project specific information
          x-versionadded: v2.24
        naCount:
          description: number of missing values
          type: integer
        name:
          description: feature name
          type: string
        parentFeatureNames:
          description: an array of string feature names indicating which features
            in the input data were used to create this feature if the feature is a
            transformation.
          items:
            type: string
          type: array
        projectId:
          description: the ID of the project the feature belongs to
          type: string
        stdDev:
          description: standard deviation of EDA sample of the feature.
          nullable: true
          oneOf:
          - description: standard deviation of EDA sample of the feature.
            type: string
          - description: standard deviation of EDA sample of the feature.
            type: number
        targetLeakage:
          description: the detected level of risk for target leakage, if any. 'SKIPPED_DETECTION'
            indicates leakage detection was not run on the feature, 'FALSE' indicates
            no leakage, 'MODERATE_RISK' indicates a moderate risk of target leakage,
            and 'HIGH_RISK' indicates a high risk of target leakage.
          enum:
          - 'FALSE'
          - HIGH_RISK
          - MODERATE_RISK
          - SKIPPED_DETECTION
          type: string
        targetLeakageReason:
          description: descriptive sentence explaining the reason for target leakage.
          type: string
          x-versionadded: v2.20
        uniqueCount:
          description: number of unique values
          type: integer
      required:
      - dateFormat
      - featureLineageId
      - featureType
      - importance
      - lowInformation
      - max
      - mean
      - median
      - min
      - naCount
      - name
      - projectId
      - stdDev
      - targetLeakage
      - targetLeakageReason
      type: object
    ModelingFeaturesCreateFromDiscarded:
      properties:
        featuresToRestore:
          description: Discarded features to restore.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - featuresToRestore
      type: object
    ModelingFeaturesCreateFromDiscardedResponse:
      properties:
        featuresToRestore:
          description: Features to add back to the project.
          items:
            type: string
          type: array
        warnings:
          description: Warnings about features which can not be restored.
          items:
            type: string
          type: array
      required:
      - featuresToRestore
      - warnings
      type: object
    ModelingJobListResponse:
      properties:
        data:
          description: List of modeling jobs.
          items:
            $ref: '#/components/schemas/ModelJobResponse'
          type: array
      required:
      - data
      type: object
    ModifyUsersInGroup:
      properties:
        users:
          description: The users to change membership for.
          items:
            $ref: '#/components/schemas/Username'
          maxItems: 100
          type: array
      required:
      - users
      type: object
    MonitoringAggregation:
      properties:
        retentionPolicy:
          default: percentage
          description: Monitoring jobs retention policy for aggregation.
          enum:
          - samples
          - percentage
          type: string
        retentionValue:
          default: 0
          description: Amount/percentage of samples to retain.
          type: integer
      type: object
    MonitoringBatch:
      properties:
        batchPredictionJobId:
          description: ID of the batch prediction job associated with the batch.
          nullable: true
          type: string
          x-versionadded: v2.33
        batchPredictionJobStatus:
          default: null
          description: Status of the batch prediction job associated with the batch
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          nullable: true
          type: string
          x-versionadded: v2.33
        createdAt:
          description: Creation timestamp of the monitoring batch.
          format: date-time
          type: string
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/MonitoringBatchCreator'
          description: Creator of the monitoring batch.
          x-versionadded: v2.33
        description:
          description: Description of the monitoring batch.
          nullable: true
          type: string
          x-versionadded: v2.33
        earliestPredictionTimestamp:
          description: Earliest prediction request timestamp in the monitoring batch.
          format: date-time
          type: string
          x-versionadded: v2.33
        externalContextUrl:
          description: External URL associated with the batch.
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: ID of the monitoring batch.
          type: string
          x-versionadded: v2.33
        isLocked:
          description: Whether or not predictions can be added to the batch
          type: boolean
          x-versionadded: v2.33
        latestPredictionTimestamp:
          description: Latest prediction request timestamp in the monitoring batch.
          format: date-time
          type: string
          x-versionadded: v2.33
        name:
          description: Name of the monitoring batch.
          type: string
          x-versionadded: v2.33
        predictionsCount:
          description: Count of predictions rows in the monitoring batch.
          type: integer
          x-versionadded: v2.33
        serviceHealth:
          $ref: '#/components/schemas/MonitoringBatchServiceHealth'
          description: Service health of the monitoring batch.
          x-versionadded: v2.33
      required:
      - batchPredictionJobId
      - batchPredictionJobStatus
      - createdAt
      - createdBy
      - description
      - earliestPredictionTimestamp
      - externalContextUrl
      - id
      - isLocked
      - latestPredictionTimestamp
      - name
      - predictionsCount
      - serviceHealth
      type: object
    MonitoringBatchCreateUpdate:
      properties:
        batchName:
          description: Name of the monitoring batch.
          type: string
          x-versionadded: v2.33
        description:
          description: Description of the monitoring batch.
          nullable: true
          type: string
          x-versionadded: v2.33
        externalContextUrl:
          description: External URL associated with the batch.
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        isLocked:
          description: Whether or not predictions can be added to the batch
          nullable: true
          type: boolean
          x-versionadded: v2.33
      type: object
    MonitoringBatchCreator:
      properties:
        id:
          description: ID of the user who created the monitoring batch.
          type: string
          x-versionadded: v2.33
        name:
          description: Name of the user who created monitoring batch.
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      type: object
    MonitoringBatchListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of monitoring batches.
          items:
            $ref: '#/components/schemas/MonitoringBatch'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    MonitoringBatchModel:
      properties:
        batchId:
          description: ID of this monitoring batch.
          type: string
          x-versionadded: v2.33
        endTime:
          description: Latest time of a prediction on this model in this batch
          format: date-time
          type: string
          x-versionadded: v2.33
        modelId:
          description: ID of a model with data on this batch
          type: string
          x-versionadded: v2.33
        predictionsCount:
          description: Count of predictions rows on this model in this batch
          type: integer
          x-versionadded: v2.33
        startTime:
          description: Earliest time of a prediction on this model in this batch
          format: date-time
          type: string
          x-versionadded: v2.33
      required:
      - batchId
      - endTime
      - modelId
      - predictionsCount
      - startTime
      type: object
    MonitoringBatchModelListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of models with data on a monitoring batch.
          items:
            $ref: '#/components/schemas/MonitoringBatchModel'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    MonitoringBatchModelUpdate:
      properties:
        endTime:
          description: Latest time of predictions on this model in this batch.
          format: date-time
          type: string
          x-versionadded: v2.33
        startTime:
          description: Earliest time of predictions on this model in this batch.
          format: date-time
          type: string
          x-versionadded: v2.33
      type: object
    MonitoringBatchServiceHealth:
      properties:
        message:
          description: Monitoring batch service health message.
          type: string
          x-versionadded: v2.33
        status:
          description: Monitoring batch service health status.
          type: string
          x-versionadded: v2.33
      required:
      - message
      - status
      type: object
    MonitoringColumnsMapping:
      properties:
        actedUponColumn:
          description: Name of column that contains value for acted_on.
          type: string
        actualsTimestampColumn:
          description: Name of column that contains actual timestamps.
          type: string
        actualsValueColumn:
          description: Name of column that contains actuals value.
          type: string
        associationIdColumn:
          description: Name of column that contains association Id.
          type: string
        customMetricId:
          description: Id of custom metric to process values for.
          type: string
        customMetricTimestampColumn:
          description: Name of column that contains custom metric values timestamps.
          type: string
        customMetricTimestampFormat:
          description: Format of timestamps from customMetricTimestampColumn.
          type: string
        customMetricValueColumn:
          description: Name of column that contains values for custom metric.
          type: string
        monitoredStatusColumn:
          description: Column name used to mark monitored rows.
          type: string
        predictionsColumns:
          description: Name of the column(s) which contain prediction values.
          oneOf:
          - description: Map containing column name(s) and class name(s) for multiclass
              problem.
            items:
              $ref: '#/components/schemas/PredictionColumMap'
            type: array
          - description: Column name that contains the prediction for regressions
              problem.
            type: string
        reportDrift:
          description: True to report drift, False otherwise.
          type: boolean
        reportPredictions:
          description: True to report prediction, False otherwise.
          type: boolean
        uniqueRowIdentifierColumns:
          description: Column(s) name of unique row identifiers.
          items:
            type: string
          type: array
      type: object
    MonitoringDataDeletePayload:
      properties:
        end:
          description: 'End of the period to delete monitoring data, defaults to the
            next top of the hour. Note: this field only accepts top of the hour RFC3339
            datetime strings, for example: ``2019-08-01T00:00:00Z``.'
          format: date-time
          nullable: true
          type: string
        modelId:
          description: The id of the model for which monitoring data are being deleted.
          type: string
        start:
          description: 'Start of the period to delete monitoring data, defaults to
            7 days ago from the end of the period. Note: this field only accepts top
            of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
          format: date-time
          nullable: true
          type: string
      required:
      - modelId
      type: object
    MonitoringOutputSettings:
      properties:
        monitoredStatusColumn:
          description: Column name used to mark monitored rows.
          type: string
        uniqueRowIdentifierColumns:
          description: Column(s) name of unique row identifiers.
          items:
            type: string
          type: array
      required:
      - monitoredStatusColumn
      - uniqueRowIdentifierColumns
      type: object
    MulticategoricalHistogram:
      properties:
        featureName:
          description: Feature name.
          type: string
        histogram:
          description: Feature histogram.
          items:
            $ref: '#/components/schemas/MulticategoricalHistogramItem'
          maxItems: 1000
          minItems: 1
          type: array
        projectId:
          description: Project Id.
          type: string
      required:
      - featureName
      - histogram
      - projectId
      type: object
    MulticategoricalHistogramItem:
      properties:
        label:
          description: Label name.
          type: string
        plot:
          description: Relevance histogram for label.
          items:
            $ref: '#/components/schemas/LabelRelevancePlot'
          maxItems: 2
          minItems: 2
          type: array
      required:
      - label
      - plot
      type: object
    MulticategoricalInvalidFormatErrorData:
      properties:
        errors:
          description: Multicategorical format errors.
          items:
            $ref: '#/components/schemas/MulticategoricalInvalidFormatErrorList'
          maxItems: 100
          type: array
      required:
      - errors
      type: object
    MulticategoricalInvalidFormatErrorList:
      properties:
        error:
          description: Error type.
          type: string
        feature:
          description: Feature name.
          type: string
        rowData:
          description: Content of the row containing format error.
          nullable: true
          type: string
        rowIndex:
          description: Row index of the row containing format error.
          nullable: true
          type: integer
      required:
      - error
      - feature
      - rowData
      - rowIndex
      type: object
    MulticategoricalInvalidFormatResponse:
      properties:
        data:
          $ref: '#/components/schemas/MulticategoricalInvalidFormatErrorData'
          description: Error data.
        projectId:
          description: The ID of the project this request is associated with.
          type: string
      required:
      - data
      - projectId
      type: object
    MulticlassDatetimeFeatureEffectsResponse:
      properties:
        backtestIndex:
          description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
            `startstop`.'
          type: string
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of feature effects scores for each class in multiclass
            project.
          items:
            $ref: '#/components/schemas/MulticlassFeatureEffects'
          type: array
        modelId:
          description: The model ID
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        projectId:
          description: The project ID
          type: string
        source:
          description: Models data source.
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - backtestIndex
      - data
      - modelId
      - next
      - previous
      - projectId
      - source
      - totalCount
      type: object
    MulticlassFeatureEffectCreate:
      properties:
        features:
          description: The list of features to use to calculate feature effects.
          items:
            type: string
          maxItems: 20000
          nullable: true
          type: array
        rowCount:
          description: The number of rows from dataset to use for Feature Impact calculation.
          maximum: 100000
          minimum: 10
          nullable: true
          type: integer
          x-versionadded: v2.21
        topNFeatures:
          description: Number of top features (ranked by feature impact) to use to
            calculate feature effects.
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          nullable: true
          type: integer
      type: object
    MulticlassFeatureEffectDatetimeCreate:
      properties:
        backtestIndex:
          description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
            `startstop`.'
          type: string
        features:
          description: The list of features to use to calculate feature effects.
          items:
            type: string
          maxItems: 20000
          nullable: true
          type: array
        rowCount:
          description: The number of rows from dataset to use for Feature Impact calculation.
          maximum: 100000
          minimum: 10
          nullable: true
          type: integer
          x-versionadded: v2.21
        topNFeatures:
          description: Number of top features (ranked by feature impact) to use to
            calculate feature effects.
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          nullable: true
          type: integer
      required:
      - backtestIndex
      type: object
    MulticlassFeatureEffects:
      properties:
        class:
          description: Target class label.
          type: string
        featureImpactScore:
          description: Feature impact score.
          type: number
        featureName:
          description: Name of the feature.
          type: string
        featureType:
          description: Feature type, either numeric or categorical.
          type: string
        isBinnable:
          description: Whether values can be grouped into bins.
          type: boolean
        isScalable:
          description: Whether numeric feature values can be reported on a log scale.
          nullable: true
          type: boolean
        partialDependence:
          $ref: '#/components/schemas/PartialDependence'
          description: Partial dependence results. Can be missing if no data for the
            feature was qualified to generate the insight.
        predictedVsActual:
          $ref: '#/components/schemas/PredictedVsActual'
          description: Predicted versus actual results. Can be missing if no data
            for the feature was qualified to generate the insight.
        weightLabel:
          description: Weight label if weight was configured for the project.
          nullable: true
          type: string
      required:
      - class
      - featureImpactScore
      - featureName
      - featureType
      - isBinnable
      - isScalable
      - weightLabel
      type: object
    MulticlassFeatureEffectsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of feature effects scores for each class in multiclass
            project.
          items:
            $ref: '#/components/schemas/MulticlassFeatureEffects'
          type: array
        modelId:
          description: The model ID
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        projectId:
          description: The project ID
          type: string
        source:
          description: Models data source.
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - modelId
      - next
      - previous
      - projectId
      - source
      - totalCount
      type: object
    MulticlassFeatureImpact:
      properties:
        class:
          description: Target class label.
          type: string
        featureImpacts:
          description: A list which contains feature impact scores for each feature
            used by a model. If the model has more than 1000 features, the most important
            1000 features are returned.
          items:
            $ref: '#/components/schemas/FeatureImpactItem'
          maxItems: 1000
          type: array
      required:
      - class
      - featureImpacts
      type: object
    MulticlassFeatureImpactResponse:
      properties:
        classFeatureImpacts:
          description: A list of feature importance scores for each class in multiclass
            project.
          items:
            $ref: '#/components/schemas/MulticlassFeatureImpact'
          type: array
        count:
          description: Number of feature impact records in a given batch.
          type: integer
        next:
          description: URL for the next page of results or `null`.
          format: uri
          nullable: true
          type: string
        previous:
          description: URL for the next page of results or `null`.
          format: uri
          nullable: true
          type: string
        ranRedundancyDetection:
          description: Indicates whether redundant feature identification was run
            while calculating this feature impact. Currently always False, as redundant
            feature identification isn't supported for multiclass in DataRobot.
          type: boolean
        shapBased:
          description: Indicates whether feature impact was calculated using Shapley
            values. Currently always `False`, as SHAP isn't supported for multiclass
            in DataRobot.
          type: boolean
      required:
      - classFeatureImpacts
      - count
      - next
      - previous
      - ranRedundancyDetection
      - shapBased
      type: object
    MulticlassLiftBinResponse:
      properties:
        bins:
          description: The lift chart data for that source, as specified below.
          items:
            $ref: '#/components/schemas/LiftBinResponse'
          type: array
        targetClass:
          description: Target class for the lift chart.
          type: string
      required:
      - bins
      - targetClass
      type: object
    MulticlassLiftChartForDatasetsList:
      properties:
        count:
          description: Number of results returned on this page.
          type: integer
        data:
          description: Array of multiclass lift chart data for dataset, as specified
            below.
          items:
            $ref: '#/components/schemas/MulticlassLiftData'
          type: array
        modelId:
          description: The model id to which the chart data belongs.
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        projectId:
          description: The project id to which the chart data belongs.
          type: string
        totalCount:
          description: Total count of multiclass lift charts matching to the query
            condition.
          type: integer
      required:
      - count
      - data
      - modelId
      - next
      - previous
      - projectId
      - totalCount
      type: object
    MulticlassLiftData:
      properties:
        classBins:
          description: List of lift chart data for each target class.
          items:
            $ref: '#/components/schemas/MulticlassLiftDataClassBins'
          type: array
        datasetId:
          description: The dataset id of dataset which was used to compute Lift chart.
          type: string
      required:
      - classBins
      - datasetId
      type: object
    MulticlassLiftDataClassBins:
      properties:
        bins:
          description: The lift chart data for that source and class, as specified
            below.
          items:
            $ref: '#/components/schemas/LiftChartbins'
          type: array
        targetClass:
          description: The target class for the lift chart.
          type: string
      required:
      - bins
      - targetClass
      type: object
    MulticlassModelLiftChartResponse:
      properties:
        classBins:
          description: List of lift chart data for each target class.
          items:
            $ref: '#/components/schemas/MulticlassLiftBinResponse'
          type: array
        source:
          description: Source of the data
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      required:
      - classBins
      - source
      type: object
    MultilabelInsightsResponse:
      properties:
        multilabelInsightsKey:
          description: Key for multilabel insights, unique per project, feature, and
            EDA stage. The response will contain the key for the most recent, finished
            EDA stage.
          type: string
      required:
      - multilabelInsightsKey
      type: object
    MultiseriesHistogramsBin:
      properties:
        count:
          description: The value count of the bin
          type: integer
        left:
          description: The inclusive left boundary of the bin.
          oneOf:
          - type: number
          - type: string
        right:
          description: The exclusive right boundary of the bin. The last bin has an
            inclusive right boundary.
          oneOf:
          - type: number
          - type: string
      required:
      - count
      - left
      - right
      type: object
    MultiseriesHistogramsRetrieveResponse:
      properties:
        bins:
          description: List of bins representing histogram.
          items:
            $ref: '#/components/schemas/MultiseriesHistogramsBin'
          type: array
      required:
      - bins
      type: object
    MultiseriesIdColumnsRecord:
      properties:
        multiseriesIdColumns:
          description: A list of one or more names of columns that contain the individual
            series identifiers if the dataset consists of multiple time series.
          items:
            type: string
          minItems: 1
          type: array
        timeStep:
          description: 'timeStep: detected time step'
          type: integer
        timeUnit:
          description: detected time unit (e.g. DAY, HOUR, etc.)
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          type: string
      required:
      - multiseriesIdColumns
      - timeStep
      - timeUnit
      type: object
    MultiseriesNamesControllerDataRecord:
      properties:
        items:
          description: List of series names
          items:
            description: Name of one series item
            type: string
          type: array
      required:
      - items
      type: object
    MultiseriesNamesControllerResponse:
      properties:
        count:
          description: Total number of series items in the response
          type: integer
        data:
          $ref: '#/components/schemas/MultiseriesNamesControllerDataRecord'
          description: Data fields of the multi series names
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
        totalSeriesCount:
          description: Total number of series items
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalSeriesCount
      type: object
    MultiseriesPayload:
      properties:
        datetimePartitionColumn:
          description: The date column that will be used to perform detection and
            validation for.
          type: string
        multiseriesIdColumns:
          description: List of one or more names of potential multiseries id columns.  If
            not provided, all numerical and categorical columns are used.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - datetimePartitionColumn
      type: object
    MultiseriesRetrieveResponse:
      properties:
        datetimePartitionColumn:
          description: The datetime partition column name.
          type: string
        detectedMultiseriesIdColumns:
          description: A list of detected multiseries ID columns along with timeStep
            and timeUnit information. Note that if no eligible columns have been detected,
            this list will be empty.
          items:
            $ref: '#/components/schemas/MultiseriesIdColumnsRecord'
            description: Detected multiseries ID columns along with timeStep and timeUnit
              information
          type: array
      required:
      - datetimePartitionColumn
      - detectedMultiseriesIdColumns
      type: object
    NodeDescription:
      properties:
        id:
          description: The ID of the node.
          type: string
        label:
          description: The label of the node.
          type: string
      required:
      - id
      - label
      type: object
    NotificationChannel:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          nullable: true
          type: string
        createdAt:
          description: The date of the notification channel creation.
          format: date-time
          type: string
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          nullable: true
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          nullable: true
          type: string
        id:
          description: The id of the notification channel.
          type: string
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          nullable: true
          type: string
        name:
          description: The name of the new notification channel.
          type: string
        orgId:
          description: The id of organization that notification channel belongs to.
          nullable: true
          type: string
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          nullable: true
          type: string
        secretToken:
          description: Secret token to be used for new notification channel.
          nullable: true
          type: string
        uid:
          description: The identifier of the user who created the channel.
          nullable: true
          type: string
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          nullable: true
          type: string
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          nullable: true
          type: boolean
      required:
      - channelType
      - contentType
      - createdAt
      - customHeaders
      - emailAddress
      - id
      - languageCode
      - name
      - orgId
      - payloadUrl
      - secretToken
      - uid
      - updatedAt
      - validateSsl
      type: object
    NotificationChannelCreate:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          type: string
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          type: string
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type: string
        name:
          description: The name of the new notification channel.
          maxLength: 100
          type: string
        orgId:
          description: The id of organization that notification channel belongs to.
          type: string
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type: string
        secretToken:
          description: Secret token to be used for new notification channel.
          type: string
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type: boolean
        verificationCode:
          description: Required if the channel type is Email.
          type: string
      required:
      - channelType
      - name
      type: object
    NotificationChannelResponse:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          nullable: true
          type: string
        createdAt:
          description: The date of the notification channel creation.
          format: date-time
          type: string
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          nullable: true
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          nullable: true
          type: string
        id:
          description: The id of the notification channel.
          type: string
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          nullable: true
          type: string
        lastNotificationAt:
          description: The timestamp of the last notification sent to the channel.
          format: date-time
          nullable: true
          type: string
        name:
          description: The name of the new notification channel.
          type: string
        orgId:
          description: The id of organization that notification channel belongs to.
          nullable: true
          type: string
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          nullable: true
          type: string
        policyCount:
          description: Count of policies assigned to the channel.
          type: integer
        secretToken:
          description: Secret token to be used for new notification channel.
          nullable: true
          type: string
        uid:
          description: The identifier of the user who created the channel.
          nullable: true
          type: string
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          nullable: true
          type: string
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          nullable: true
          type: boolean
      required:
      - channelType
      - contentType
      - createdAt
      - customHeaders
      - emailAddress
      - id
      - languageCode
      - lastNotificationAt
      - name
      - orgId
      - payloadUrl
      - policyCount
      - secretToken
      - uid
      - updatedAt
      - validateSsl
      type: object
    NotificationChannelTempPolicyTemplateResponse:
      properties:
        id:
          description: The id of the policy template.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy template.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity template.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      - relatedEntityType
      type: object
    NotificationChannelTemplateCreate:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - DataRobotCustomJob
          - DataRobotGroup
          - DataRobotUser
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
          x-versionadded: v2.33
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          type: string
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          type: array
          x-versionadded: v2.33
        drEntities:
          description: The IDs of the DataRobot Users, Group or Custom Job associated
            with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
          items:
            $ref: '#/components/schemas/DREntity'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          type: string
          x-versionadded: v2.33
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          maxLength: 100
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of organization that notification channel belongs to.
          type: string
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          type: string
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type: boolean
          x-versionadded: v2.33
        verificationCode:
          description: Required if the channel type is Email.
          type: string
          x-versionadded: v2.33
      required:
      - channelType
      - name
      type: object
    NotificationChannelTemplateRelatedPoliciesListResponse:
      properties:
        count:
          description: The number of entity policies returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The entity notification policies.
          items:
            $ref: '#/components/schemas/NotificationChannelTemplateRelatedPolicyResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of entity policies that satisfy the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    NotificationChannelTemplateRelatedPolicyResponse:
      properties:
        id:
          description: The id of the policy.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          type: string
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityName:
          description: The name of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      - relatedEntityId
      - relatedEntityName
      - relatedEntityType
      type: object
    NotificationChannelTemplateRelatedPolicyTemplateListResponse:
      properties:
        count:
          description: The number of entity policies returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The entity notification policy template.
          items:
            $ref: '#/components/schemas/NotificationChannelTempPolicyTemplateResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of entity policies that satisfy the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    NotificationChannelTemplateResponse:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - DataRobotCustomJob
          - DataRobotGroup
          - DataRobotUser
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
          x-versionadded: v2.33
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          nullable: true
          type: string
          x-versionadded: v2.33
        createdAt:
          description: The date of the notification channel creation.
          format: date-time
          type: string
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/ChannelCreatedByResponse'
          description: User that created template.
          nullable: true
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          nullable: true
          type: array
          x-versionadded: v2.33
        drEntities:
          description: The IDs of the DataRobot Users, Group or Custom Job associated
            with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
          items:
            $ref: '#/components/schemas/DREntity'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: The id of the notification channel.
          type: string
          x-versionadded: v2.33
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          nullable: true
          type: string
          x-versionadded: v2.33
        lastNotificationAt:
          description: The timestamp of the last notification sent to the channel.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          type: string
          x-versionadded: v2.33
        orgId:
          description: The id of organization that notification channel belongs to.
          nullable: true
          type: string
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        policyCount:
          description: Count of policies assigned to the channel.
          type: integer
          x-versionadded: v2.33
        policyTemplatesCount:
          description: Count of policiestemplates  assigned to the channel.
          type: integer
          x-versionadded: v2.33
        role:
          description: User role on entity.
          nullable: true
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the channel.
          nullable: true
          type: string
          x-versionadded: v2.33
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          nullable: true
          type: boolean
          x-versionadded: v2.33
      required:
      - channelType
      - contentType
      - createdAt
      - createdBy
      - customHeaders
      - emailAddress
      - id
      - languageCode
      - lastNotificationAt
      - name
      - orgId
      - payloadUrl
      - policyCount
      - policyTemplatesCount
      - role
      - secretToken
      - uid
      - updatedAt
      - validateSsl
      type: object
    NotificationChannelTemplatesListResponse:
      properties:
        count:
          description: The number of channel templates returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The notification channel templates.
          items:
            $ref: '#/components/schemas/NotificationChannelTemplateResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of channel templates that satisfy the query.
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    NotificationChannelUpdate:
      properties:
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          type: string
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          type: string
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type: string
        name:
          description: The name of the new notification channel.
          maxLength: 100
          type: string
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type: string
        secretToken:
          description: Secret token to be used for new notification channel.
          type: string
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type: boolean
        verificationCode:
          description: Required if the channel type is Email.
          type: string
      type: object
    NotificationChannelWithDREntityUpdate:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - DataRobotCustomJob
          - DataRobotGroup
          - DataRobotUser
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
          x-versionadded: v2.33
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          type: string
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          type: array
          x-versionadded: v2.33
        drEntities:
          description: The IDs of the DataRobot Users, Group or Custom Job associated
            with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.
          items:
            $ref: '#/components/schemas/DREntity'
          maxItems: 100
          minItems: 1
          nullable: true
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          type: string
          x-versionadded: v2.33
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          maxLength: 100
          type: string
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          type: string
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type: boolean
          x-versionadded: v2.33
        verificationCode:
          description: Required if the channel type is Email.
          type: string
          x-versionadded: v2.33
      type: object
    NotificationChannelsListResponse:
      properties:
        count:
          description: The number of channels returned.
          type: integer
        data:
          description: The notification channels.
          items:
            $ref: '#/components/schemas/NotificationChannelResponse'
          type: array
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
        totalCount:
          description: The total number of channels that satisfy the query.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    NotificationEmailChannelVerification:
      properties:
        channelType:
          description: The type of the new notification channel
          type: string
        emailAddress:
          description: The email address of the recipient
          type: string
        name:
          description: The name of the new notification channel
          maxLength: 100
          type: string
        orgId:
          description: The id of organization that notification channel belongs to
          type: string
      required:
      - channelType
      - emailAddress
      - name
      type: object
    NotificationEmailChannelVerificationResponse:
      properties:
        notificationId:
          description: The response body is the json object with notification_id in
            it
          type: string
      required:
      - notificationId
      type: object
    NotificationEmailChannelVerificationStatus:
      properties:
        emailAddress:
          description: The email address of the recipient
          type: string
        verificationCode:
          description: The user entered verification code
          type: string
      required:
      - emailAddress
      - verificationCode
      type: object
    NotificationEmailChannelVerificationStatusResponse:
      properties:
        status:
          description: The status shows if admin entered the correct 6 digit verification
            code
          type: boolean
      required:
      - status
      type: object
    NotificationEventListResponse:
      properties:
        eventGroups:
          description: Selectable event groups
          items:
            $ref: '#/components/schemas/EventGroupResponse'
          type: array
        events:
          description: Selectable individual events
          items:
            $ref: '#/components/schemas/EventResponse'
          type: array
      required:
      - eventGroups
      - events
      type: object
    NotificationLog:
      properties:
        channelId:
          description: The id of the channel that was used to send the notification.
          type: string
        channelScope:
          description: Scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          nullable: true
          type: string
        emailSubject:
          description: The email subject of the notification.
          nullable: true
          type: string
        id:
          description: The id of the notification log.
          type: string
        parentNotificationId:
          description: The id of the parent notification.
          nullable: true
          type: string
        policyId:
          description: The id of the policy that was used to send the notification.
          type: string
        request:
          description: The request that was sent in the notification.
          nullable: true
          type: string
        response:
          description: The response that was received after sending the notification.
          nullable: true
          type: string
        retryCount:
          description: The number of attempts to send the notification.
          nullable: true
          type: integer
        status:
          description: The status of the notification.
          type: string
        timestamp:
          description: The date when the notification was sent.
          format: date-time
          type: string
      required:
      - channelId
      - channelScope
      - emailSubject
      - id
      - parentNotificationId
      - policyId
      - request
      - response
      - retryCount
      - status
      - timestamp
      type: object
    NotificationLogListDataResponse:
      properties:
        channelId:
          description: The id of the channel that was used to send the notification
          type: string
        channelScope:
          description: Scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          nullable: true
          type: string
        emailSubject:
          description: The email subject
          type: string
        id:
          description: The id of the notification log
          type: string
        parentNotificationId:
          description: The ID of the parent notification
          nullable: true
          type: string
        policyId:
          description: the id of the policy that was used to send the notification
          type: string
        request:
          $ref: '#/components/schemas/RequestNotification'
          description: The request that was sent in the notification
        response:
          $ref: '#/components/schemas/ResponseNotification'
          description: The response that was received after sending the notification
        retryCount:
          description: The count of the retries while sending the notification
          type: integer
        status:
          description: The status of the notification
          nullable: true
          type: string
        timestamp:
          description: The date and time when the notification was sent
          format: date-time
          type: string
      required:
      - channelId
      - channelScope
      - emailSubject
      - id
      - parentNotificationId
      - policyId
      - request
      - response
      - retryCount
      - status
      - timestamp
      type: object
    NotificationLogListResponse:
      properties:
        count:
          description: Number of items returned on this page
          type: integer
        data:
          description: An array notification logs
          items:
            $ref: '#/components/schemas/NotificationLogListDataResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: 'The total number of notifications '
          type: integer
      required:
      - count
      - data
      - next
      - previous
      type: object
    NotificationPoliciesListResponse:
      properties:
        count:
          description: The number of policies returned.
          type: integer
        data:
          description: The notification policies.
          items:
            $ref: '#/components/schemas/NotificationPolicyResponse'
          type: array
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
        totalCount:
          description: The total number of policies that satisfy the query.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    NotificationPolicyCreate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
        eventGroup:
          description: The group of the event that trigger the notification.
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
        eventType:
          description: The type of the event that triggers the notification.
          enum:
          - secure_config.created
          - secure_config.deleted
          - secure_config.shared
          - comment.created
          - comment.updated
          - credits_system.empty_balance
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.credits_usage
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - decision_flow.shared
          - misc.asset_access_request
          - misc.webhook_connection_test
          - misc.webhook_resend
          - misc.email_verification
          - monitoring.spooler_channel_base
          - monitoring.spooler_channel_red
          - monitoring.spooler_channel_green
          - monitoring.external_model_nan_predictions
          - management.deploymentInfo
          - model_deployments.None
          - model_deployments.deployment_sharing
          - model_deployments.model_replacement
          - prediction_request.None
          - prediction_request.failed
          - model_deployments.model_replacement_lifecycle
          - model_deployments.model_replacement_started
          - model_deployments.model_replacement_succeeded
          - model_deployments.model_replacement_failed
          - model_deployments.model_replacement_validation_warning
          - model_deployments.deployment_creation
          - model_deployments.deployment_deletion
          - model_deployments.service_health_yellow_from_green
          - model_deployments.service_health_yellow_from_red
          - model_deployments.service_health_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.data_drift_yellow_from_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.accuracy_yellow_from_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.green_to_yellow
          - model_deployments.health.fairness_health.red_to_yellow
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.green_to_yellow
          - model_deployments.health.custom_metrics_health.red_to_yellow
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.health.base.green
          - model_deployments.service_health_green
          - model_deployments.data_drift_green
          - model_deployments.accuracy_green
          - model_deployments.health.fairness_health.green
          - model_deployments.health.custom_metrics_health.green
          - model_deployments.retraining_policy_run_started
          - model_deployments.retraining_policy_run_succeeded
          - model_deployments.retraining_policy_run_failed
          - model_deployments.challenger_scoring_finished
          - model_deployments.challenger_scoring_success
          - model_deployments.challenger_scoring_data_warning
          - model_deployments.challenger_scoring_failure
          - model_deployments.challenger_scoring_started
          - model_deployments.challenger_model_validation_warning
          - model_deployments.challenger_model_created
          - model_deployments.challenger_model_deleted
          - model_deployments.actuals_upload_failed
          - model_deployments.actuals_upload_warning
          - model_deployments.training_data_baseline_calculation_started
          - model_deployments.training_data_baseline_calculation_completed
          - model_deployments.training_data_baseline_failed
          - model_deployments.custom_model_deployment_creation_started
          - model_deployments.custom_model_deployment_creation_completed
          - model_deployments.custom_model_deployment_creation_failed
          - model_deployments.deployment_prediction_explanations_preview_job_submitted
          - model_deployments.deployment_prediction_explanations_preview_job_completed
          - model_deployments.deployment_prediction_explanations_preview_job_failed
          - model_deployments.custom_model_deployment_activated
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.prediction_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_warning
          - model_deployments.actuals_processing_rate_limit_reached
          - model_deployments.actuals_processing_rate_limit_warning
          - model_deployments.deployment_monitoring_data_cleared
          - model_deployments.deployment_launch_started
          - model_deployments.deployment_launch_succeeded
          - model_deployments.deployment_launch_failed
          - model_deployments.deployment_shutdown_started
          - model_deployments.deployment_shutdown_succeeded
          - model_deployments.deployment_shutdown_failed
          - model_deployments.endpoint_update_started
          - model_deployments.endpoint_update_succeeded
          - model_deployments.endpoint_update_failed
          - model_deployments.management_agent_service_health_green
          - model_deployments.management_agent_service_health_yellow
          - model_deployments.management_agent_service_health_red
          - model_deployments.management_agent_service_health_unknown
          - model_deployments.predictions_missing_association_id
          - model_deployments.prediction_result_rows_cleand_up
          - model_deployments.batch_deleted
          - model_deployments.batch_creation_limit_reached
          - model_deployments.batch_creation_limit_exceeded
          - model_deployments.batch_not_found
          - model_deployments.predictions_encountered_for_locked_batch
          - model_deployments.predictions_encountered_for_deleted_batch
          - model_deployments.scheduled_report_generated
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.service_health_still_red
          - model_deployments.data_drift_still_red
          - model_deployments.accuracy_still_red
          - model_deployments.health.fairness_health.still_red
          - model_deployments.health.custom_metrics_health.still_red
          - model_deployments.predictions_timeliness_health_still_red
          - model_deployments.actuals_timeliness_health_still_red
          - model_deployments.service_health_still_yellow
          - model_deployments.data_drift_still_yellow
          - model_deployments.accuracy_still_yellow
          - model_deployments.health.fairness_health.still_yellow
          - model_deployments.health.custom_metrics_health.still_yellow
          - model_deployments.deployment_inference_server_creation_started
          - model_deployments.deployment_inference_server_creation_failed
          - model_deployments.deployment_inference_server_creation_completed
          - model_deployments.deployment_inference_server_deletion
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - project.created
          - project.deleted
          - project.shared
          - autopilot.complete
          - autopilot.started
          - autostart.failure
          - perma_delete_project.success
          - perma_delete_project.failure
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - users_delete.started
          - users_delete.completed
          - users_delete.failed
          - application.created
          - application.shared
          - model_version.added
          - model_version.stage_transition_from_registered_to_development
          - model_version.stage_transition_from_registered_to_staging
          - model_version.stage_transition_from_registered_to_production
          - model_version.stage_transition_from_registered_to_archived
          - model_version.stage_transition_from_development_to_registered
          - model_version.stage_transition_from_development_to_staging
          - model_version.stage_transition_from_development_to_production
          - model_version.stage_transition_from_development_to_archived
          - model_version.stage_transition_from_staging_to_registered
          - model_version.stage_transition_from_staging_to_development
          - model_version.stage_transition_from_staging_to_production
          - model_version.stage_transition_from_staging_to_archived
          - model_version.stage_transition_from_production_to_registered
          - model_version.stage_transition_from_production_to_development
          - model_version.stage_transition_from_production_to_staging
          - model_version.stage_transition_from_production_to_archived
          - model_version.stage_transition_from_archived_to_registered
          - model_version.stage_transition_from_archived_to_development
          - model_version.stage_transition_from_archived_to_production
          - model_version.stage_transition_from_archived_to_staging
          - batch_predictions.success
          - batch_predictions.failed
          - batch_predictions.scheduler.auto_disabled
          - change_request.cancelled
          - change_request.created
          - change_request.deployment_approval_requested
          - change_request.resolved
          - change_request.proposed_changes_updated
          - change_request.pending
          - change_request.commenting_review_added
          - change_request.approving_review_added
          - change_request.changes_requesting_review_added
          - prediction_explanations_computation.None
          - prediction_explanations_computation.prediction_explanations_preview_job_submitted
          - prediction_explanations_computation.prediction_explanations_preview_job_completed
          - prediction_explanations_computation.prediction_explanations_preview_job_failed
          - monitoring.rate_limit_enforced
          - notebook_schedule.created
          - notebook_schedule.failure
          - notebook_schedule.completed
          type: string
        name:
          description: The name of the new notification policy.
          maxLength: 100
          type: string
        orgId:
          description: The id of the organization that owns the notification policy.
          type: string
      required:
      - channelId
      - name
      type: object
    NotificationPolicyMuteCreate:
      properties:
        entityId:
          description: The id of the entity to mute the notification for
          type: string
        policyId:
          description: The id of the policy to mute notification for
          type: string
      required:
      - entityId
      - policyId
      type: object
    NotificationPolicyMuteListResponse:
      properties:
        count:
          description: The number of items returned on this page
          type: integer
        data:
          description: A list of Notification Policy Mutes
          items:
            $ref: '#/components/schemas/NotificationPolicyMuteResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items returned by the query
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    NotificationPolicyMuteResponse:
      properties:
        entityId:
          description: The id of the entity to mute the notification for
          type: string
        id:
          description: The id of the notification policy mute
          type: string
        policyId:
          description: The id of the policy to mute notification for
          type: string
        uid:
          description: The uid of the notification policy mute
          type: string
      required:
      - entityId
      - id
      - policyId
      - uid
      type: object
    NotificationPolicyResponse:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
        channel:
          $ref: '#/components/schemas/NotificationChannel'
          description: The information notification channel to be used to send the
            notification.
          nullable: true
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
        created:
          description: The date when the policy was created.
          format: date-time
          nullable: true
          type: string
        eventGroup:
          $ref: '#/components/schemas/EventGroup'
          description: The group of the event that trigger the notification.
          nullable: true
        eventType:
          $ref: '#/components/schemas/EventType'
          description: The type of the event that triggers the notification.
          nullable: true
        id:
          description: The id of the policy.
          type: string
        lastTriggered:
          description: The date when the last notification with the policy was triggered.
          format: date-time
          nullable: true
          type: string
        name:
          description: The name of the notification policy.
          type: string
        orgId:
          description: The id of the organization that owns the notification policy.
          nullable: true
          type: string
        uid:
          description: The identifier of the user who created the policy.
          type: string
        updatedAt:
          description: The date when the policy was updated.
          format: date-time
          nullable: true
          type: string
      required:
      - active
      - channel
      - channelId
      - created
      - eventGroup
      - eventType
      - id
      - lastTriggered
      - name
      - orgId
      - uid
      - updatedAt
      type: object
    NotificationPolicyUpdate:
      properties:
        active:
          description: Defines if the notification policy is active or not.
          type: boolean
        channelId:
          description: The id of the notification channel to be used to send the notification.
          type: string
        eventGroup:
          description: The group of the event that trigger the notification.
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
        eventType:
          description: The type of the event that triggers the notification.
          enum:
          - secure_config.created
          - secure_config.deleted
          - secure_config.shared
          - comment.created
          - comment.updated
          - credits_system.empty_balance
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.credits_usage
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - decision_flow.shared
          - misc.asset_access_request
          - misc.webhook_connection_test
          - misc.webhook_resend
          - misc.email_verification
          - monitoring.spooler_channel_base
          - monitoring.spooler_channel_red
          - monitoring.spooler_channel_green
          - monitoring.external_model_nan_predictions
          - management.deploymentInfo
          - model_deployments.None
          - model_deployments.deployment_sharing
          - model_deployments.model_replacement
          - prediction_request.None
          - prediction_request.failed
          - model_deployments.model_replacement_lifecycle
          - model_deployments.model_replacement_started
          - model_deployments.model_replacement_succeeded
          - model_deployments.model_replacement_failed
          - model_deployments.model_replacement_validation_warning
          - model_deployments.deployment_creation
          - model_deployments.deployment_deletion
          - model_deployments.service_health_yellow_from_green
          - model_deployments.service_health_yellow_from_red
          - model_deployments.service_health_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.data_drift_yellow_from_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.accuracy_yellow_from_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.green_to_yellow
          - model_deployments.health.fairness_health.red_to_yellow
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.green_to_yellow
          - model_deployments.health.custom_metrics_health.red_to_yellow
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.health.base.green
          - model_deployments.service_health_green
          - model_deployments.data_drift_green
          - model_deployments.accuracy_green
          - model_deployments.health.fairness_health.green
          - model_deployments.health.custom_metrics_health.green
          - model_deployments.retraining_policy_run_started
          - model_deployments.retraining_policy_run_succeeded
          - model_deployments.retraining_policy_run_failed
          - model_deployments.challenger_scoring_finished
          - model_deployments.challenger_scoring_success
          - model_deployments.challenger_scoring_data_warning
          - model_deployments.challenger_scoring_failure
          - model_deployments.challenger_scoring_started
          - model_deployments.challenger_model_validation_warning
          - model_deployments.challenger_model_created
          - model_deployments.challenger_model_deleted
          - model_deployments.actuals_upload_failed
          - model_deployments.actuals_upload_warning
          - model_deployments.training_data_baseline_calculation_started
          - model_deployments.training_data_baseline_calculation_completed
          - model_deployments.training_data_baseline_failed
          - model_deployments.custom_model_deployment_creation_started
          - model_deployments.custom_model_deployment_creation_completed
          - model_deployments.custom_model_deployment_creation_failed
          - model_deployments.deployment_prediction_explanations_preview_job_submitted
          - model_deployments.deployment_prediction_explanations_preview_job_completed
          - model_deployments.deployment_prediction_explanations_preview_job_failed
          - model_deployments.custom_model_deployment_activated
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.prediction_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_reached
          - model_deployments.prediction_data_processing_rate_limit_warning
          - model_deployments.actuals_processing_rate_limit_reached
          - model_deployments.actuals_processing_rate_limit_warning
          - model_deployments.deployment_monitoring_data_cleared
          - model_deployments.deployment_launch_started
          - model_deployments.deployment_launch_succeeded
          - model_deployments.deployment_launch_failed
          - model_deployments.deployment_shutdown_started
          - model_deployments.deployment_shutdown_succeeded
          - model_deployments.deployment_shutdown_failed
          - model_deployments.endpoint_update_started
          - model_deployments.endpoint_update_succeeded
          - model_deployments.endpoint_update_failed
          - model_deployments.management_agent_service_health_green
          - model_deployments.management_agent_service_health_yellow
          - model_deployments.management_agent_service_health_red
          - model_deployments.management_agent_service_health_unknown
          - model_deployments.predictions_missing_association_id
          - model_deployments.prediction_result_rows_cleand_up
          - model_deployments.batch_deleted
          - model_deployments.batch_creation_limit_reached
          - model_deployments.batch_creation_limit_exceeded
          - model_deployments.batch_not_found
          - model_deployments.predictions_encountered_for_locked_batch
          - model_deployments.predictions_encountered_for_deleted_batch
          - model_deployments.scheduled_report_generated
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.service_health_still_red
          - model_deployments.data_drift_still_red
          - model_deployments.accuracy_still_red
          - model_deployments.health.fairness_health.still_red
          - model_deployments.health.custom_metrics_health.still_red
          - model_deployments.predictions_timeliness_health_still_red
          - model_deployments.actuals_timeliness_health_still_red
          - model_deployments.service_health_still_yellow
          - model_deployments.data_drift_still_yellow
          - model_deployments.accuracy_still_yellow
          - model_deployments.health.fairness_health.still_yellow
          - model_deployments.health.custom_metrics_health.still_yellow
          - model_deployments.deployment_inference_server_creation_started
          - model_deployments.deployment_inference_server_creation_failed
          - model_deployments.deployment_inference_server_creation_completed
          - model_deployments.deployment_inference_server_deletion
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - project.created
          - project.deleted
          - project.shared
          - autopilot.complete
          - autopilot.started
          - autostart.failure
          - perma_delete_project.success
          - perma_delete_project.failure
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - users_delete.started
          - users_delete.completed
          - users_delete.failed
          - application.created
          - application.shared
          - model_version.added
          - model_version.stage_transition_from_registered_to_development
          - model_version.stage_transition_from_registered_to_staging
          - model_version.stage_transition_from_registered_to_production
          - model_version.stage_transition_from_registered_to_archived
          - model_version.stage_transition_from_development_to_registered
          - model_version.stage_transition_from_development_to_staging
          - model_version.stage_transition_from_development_to_production
          - model_version.stage_transition_from_development_to_archived
          - model_version.stage_transition_from_staging_to_registered
          - model_version.stage_transition_from_staging_to_development
          - model_version.stage_transition_from_staging_to_production
          - model_version.stage_transition_from_staging_to_archived
          - model_version.stage_transition_from_production_to_registered
          - model_version.stage_transition_from_production_to_development
          - model_version.stage_transition_from_production_to_staging
          - model_version.stage_transition_from_production_to_archived
          - model_version.stage_transition_from_archived_to_registered
          - model_version.stage_transition_from_archived_to_development
          - model_version.stage_transition_from_archived_to_production
          - model_version.stage_transition_from_archived_to_staging
          - batch_predictions.success
          - batch_predictions.failed
          - batch_predictions.scheduler.auto_disabled
          - change_request.cancelled
          - change_request.created
          - change_request.deployment_approval_requested
          - change_request.resolved
          - change_request.proposed_changes_updated
          - change_request.pending
          - change_request.commenting_review_added
          - change_request.approving_review_added
          - change_request.changes_requesting_review_added
          - prediction_explanations_computation.None
          - prediction_explanations_computation.prediction_explanations_preview_job_submitted
          - prediction_explanations_computation.prediction_explanations_preview_job_completed
          - prediction_explanations_computation.prediction_explanations_preview_job_failed
          - monitoring.rate_limit_enforced
          - notebook_schedule.created
          - notebook_schedule.failure
          - notebook_schedule.completed
          type: string
        name:
          description: The name of the notification policy.
          maxLength: 100
          type: string
      type: object
    NotificationResend:
      properties:
        notificationId:
          description: The id of notification to resend.
          type: string
      required:
      - notificationId
      type: object
    NotificationWebhookChannelStatusResponse:
      properties:
        notificationLog:
          $ref: '#/components/schemas/NotificationLog'
          description: The notification log record.
          nullable: true
        status:
          description: The status of the test notification.
          type: string
      required:
      - notificationLog
      - status
      type: object
    NotificationWebhookChannelTestCreate:
      properties:
        channelType:
          description: The type of the new notification channel.
          enum:
          - Database
          - Email
          - InApp
          - InsightsComputations
          - MSTeams
          - Slack
          - Webhook
          type: string
        contentType:
          description: The content type of the messages of the new notification channel.
          enum:
          - application/json
          - application/x-www-form-urlencoded
          type: string
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          type: string
        name:
          description: The name of the new notification channel.
          maxLength: 100
          type: string
        orgId:
          description: The identifier of the organization that notification channel
            belongs to.
          type: string
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type: string
        secretToken:
          description: Secret token to be used for new notification channel.
          type: string
        validateSsl:
          description: Whether SSL will be validated in the notification channel.
          type: boolean
      required:
      - channelType
      - name
      type: object
    NotificationWebhookChannelTestId:
      properties:
        notificationId:
          description: The identifier of the notification.
          type: string
      required:
      - notificationId
      type: object
    NotifyStatus:
      properties:
        inviteLink:
          description: The link the user can follow to complete their DR account.
          format: uri
          type: string
        sentStatus:
          description: Boolean value whether an invite has been sent to the user or
            not.
          type: boolean
      required:
      - sentStatus
      type: object
    NumIterationsTrainedData:
      properties:
        numIterations:
          description: The number of iterations run in this stage of modeling.
          minimum: 0
          type: integer
        stage:
          description: Modeling stage or None if it is a single-stage model
          nullable: true
          type: string
      required:
      - numIterations
      - stage
      type: object
    NumIterationsTrainedResponse:
      properties:
        data:
          description: Number of estimators or iterations for a single model stage
          items:
            $ref: '#/components/schemas/NumIterationsTrainedData'
          type: array
        modelId:
          description: The model ID
          type: string
        projectId:
          description: The project ID
          type: string
      required:
      - data
      - modelId
      - projectId
      type: object
    Numeric:
      properties:
        allData:
          description: Statistic value for all data.
          nullable: true
          type: number
        insightName:
          description: Insight name.
          enum:
          - min
          - max
          - median
          - avg
          - firstQuartile
          - thirdQuartile
          - missingRowsPercent
          type: string
        perCluster:
          description: Statistic values for for each cluster.
          items:
            $ref: '#/components/schemas/PerClusterNumeric'
          type: array
      required:
      - allData
      - insightName
      - perCluster
      type: object
    NumericFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          nullable: true
          type: number
        featureName:
          description: Feature name.
          type: string
        featureType:
          description: Feature Type.
          enum:
          - numeric
          type: string
        insights:
          description: A list of Cluster Insights for a feature.
          items:
            $ref: '#/components/schemas/Numeric'
          type: array
      required:
      - featureName
      - featureType
      - insights
      type: object
    NumericStatsArguments:
      properties:
        column:
          description: Column to apply transformation to.
          type: string
          x-versionadded: v2.33
        datetimePartitionColumn:
          description: A column, which is used to order data.
          type: string
          x-versionadded: v2.33
        methods:
          description: Methods to apply in a rolling window.
          items:
            enum:
            - avg
            - max
            - median
            - min
            - stddev
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
        multiseriesIdColumn:
          default: null
          description: Series ID column, if present. Partition data by it.
          nullable: true
          type: string
          x-versionadded: v2.33
        rollingMedianSnowflakeUserDefinedFunction:
          default: null
          description: "To optimize rolling median calculation with snowflake,\n \
            \        pass qualified path to the UDF, as follows: \"DB_NAME.SCHEMA_NAME.FUNCTION_NAME\"\
            .\n         Contact DataRobot Support to fetch a suggested SQL function.\n\
            \         "
          nullable: true
          type: string
          x-versionadded: v2.33
        windowSize:
          description: Rolling window size, defined in terms of rows. Left end is
            exclusive, right end is inclusive.
          exclusiveMinimum: true
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - column
      - datetimePartitionColumn
      - methods
      - windowSize
      type: object
    OAuthCredentials:
      properties:
        credentialType:
          description: The type of these credentials, 'oauth' here.
          enum:
          - oauth
          type: string
        oauthAccessToken:
          default: null
          description: The oauth access token.
          nullable: true
          type: string
        oauthClientId:
          default: null
          description: The oauth client ID.
          nullable: true
          type: string
        oauthClientSecret:
          default: null
          description: The oauth client secret.
          nullable: true
          type: string
        oauthRefreshToken:
          description: The oauth refresh token.
          type: string
      required:
      - credentialType
      - oauthRefreshToken
      type: object
    OneMessageInfo:
      properties:
        additionalInfo:
          description: Zero or more text strings for secondary display after user
            clicks for more information.
          items:
            type: string
          maxItems: 50
          type: array
        messageLevel:
          description: Message severity level.
          enum:
          - CRITICAL
          - INFORMATIONAL
          - NO_ISSUES
          - WARNING
          type: string
        messageText:
          description: Text for primary display in UI.
          maxLength: 500
          minLength: 1
          type: string
      required:
      - messageLevel
      - messageText
      type: object
    OneOfDirective:
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/FilterDirectiveArguments'
            description: The transformation description.
          directive:
            description: The single data transformation step.
            enum:
            - filter
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/ReplaceDirectiveArguments'
            description: The transformation description.
          directive:
            description: The single data transformation step.
            enum:
            - replace
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/ComputeNewDirectiveArguments'
            description: The transformation description.
          directive:
            description: The single data transformation step.
            enum:
            - compute-new
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          directive:
            description: The single data transformation step.
            enum:
            - dedupe-rows
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/DropColumnsArguments'
            description: The transformation description.
          directive:
            description: The single data transformation step.
            enum:
            - drop-columns
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/RenameColumnsArguments'
            description: The transformation description.
          directive:
            description: The single data transformation step.
            enum:
            - rename-columns
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/JoinDirectiveArguments'
            description: The transformation description.
          directive:
            description: The single data transformation step.
            enum:
            - join
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/AggregateDirectiveArguments'
            description: The aggregation description.
          directive:
            description: The single data transformation step.
            enum:
            - aggregate
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/LagsDirectiveArguments'
            description: Lag Arguments
          directive:
            description: Lag of a Rolling Window
            enum:
            - lags
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/NumericStatsArguments'
            description: Directive arguments.
          directive:
            description: Rolling window numeric statistics directive.
            enum:
            - window-numeric-stats
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/TimeSeriesDirectiveArguments'
            description: Time series directive arguments.
          directive:
            description: Time series processing directive. Makes dataset ready for
              time series modeling. All windows are row based.
            enum:
            - time-series
            type: string
        required:
        - arguments
        - directive
        type: object
    OneOfDownsamplingDirective:
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/DownsamplingRandomDirectiveArguments'
            description: The downsampling configuration.
          directive:
            description: The downsampling method.
            enum:
            - random-sample
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/SmartDownsamplingArguments'
            description: The downsampling configuration.
          directive:
            description: The downsampling method.
            enum:
            - smart-downsampling
            type: string
        required:
        - arguments
        - directive
        type: object
    OneOfTransforms:
      discriminator:
        propertyName: name
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/BaseNumericStatsArguments'
            description: Task arguments.
          name:
            description: Task name.
            enum:
            - numeric-stats
            type: string
        required:
        - arguments
        - name
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/CategoricalStatsArguments'
            description: Task arguments.
          name:
            description: Task name.
            enum:
            - categorical-stats
            type: string
        required:
        - arguments
        - name
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/BaseLagsArguments'
            description: Task arguments.
          name:
            description: Task name.
            enum:
            - lags
            type: string
        required:
        - arguments
        - name
        type: object
    OperationDetails:
      type: object
    OptimizedDatetimePartitioningData:
      properties:
        aggregationType:
          description: For multiseries projects only. The aggregation type to apply
            when creating cross-series features.
          enum:
          - total
          - average
          type: string
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          default: false
          description: Specifies whether the time series predictions can use partial
            historical data.
          type: boolean
          x-versionadded: v2.24
        autopilotClusterList:
          description: A list of integers where each value will be used as the number
            of clusters in Autopilot model(s) for unsupervised clustering projects.
            Cannot be specified unless `unsupervisedMode` is true and `unsupervisedType`
            is set to `clustering`.
          items:
            maximum: 100
            minimum: 2
            type: integer
          maxItems: 10
          nullable: true
          type: array
          x-versionadded: v2.25
        autopilotDataSamplingMethod:
          description: Defines how autopilot will select subsample from training dataset
            in OTV/TS projects. Defaults to 'latest' for 'rowCount' dataSelectionMethod
            and to 'random' for 'duration'.
          enum:
          - random
          - latest
          type: string
        autopilotDataSelectionMethod:
          description: The Data Selection method to be used by autopilot when creating
            models for datetime-partitioned datasets.
          enum:
          - duration
          - rowCount
          type: string
        backtests:
          description: An array specifying individual backtests.
          items:
            oneOf:
            - $ref: '#/components/schemas/BacktestOldMethodForOpenApi'
              description: Method 1 - pass validation and gap durations
            - $ref: '#/components/schemas/BacktestNewMethodForOpenApi'
              description: Method 2 - directly configure the start and end dates of
                each partition, including the training partition.
          maxItems: 20
          minItems: 1
          type: array
        calendarId:
          description: The ID of the calendar to be used in this project.
          type: string
          x-versionadded: v2.15
        clusteringBufferDisabled:
          default: false
          description: A boolean value indicating whether an clustering buffer creation
            should be disabled for unsupervised time series clustering project.
          type: boolean
          x-versionadded: v2.30
        crossSeriesGroupByColumns:
          description: For multiseries projects with cross-series features enabled
            only. List of columns (currently of length 1). Setting that indicates
            how to further split series into related groups. For example, if every
            series is sales of an individual product, the series group-by could be
            the product category with values like "men's clothing", "sports equipment",
            etc.
          items:
            type: string
          maxItems: 1
          type: array
          x-versionadded: v2.15
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column.
          type: string
        defaultToAPriori:
          description: Renamed to `defaultToKnownInAdvance`.
          type: boolean
          x-versiondeprecated: v2.11
        defaultToDoNotDerive:
          description: For time series projects only. Sets whether all features default
            to being treated as do-not-derive features, excluding them from feature
            derivation. Individual features can be set to a value different than the
            default by using the `featureSettings` parameter.
          type: boolean
          x-versionadded: v2.17
        defaultToKnownInAdvance:
          description: For time series projects only. Sets whether all features default
            to being treated as known in advance features, which are features that
            are known into the future. Features marked as known in advance must be
            specified into the future when making predictions. The default is false,
            all features are not known in advance. Individual features can be set
            to a value different than the default using the `featureSettings` parameter.
            See the :ref:`Time Series Overview <time_series_overview>` for more context.
          type: boolean
          x-versionadded: v2.11
        differencingMethod:
          description: For time series projects only. Used to specify which differencing
            method to apply if the data is stationary. For classification problems
            `simple` and `seasonal` are not allowed. Parameter `periodicities` must
            be specified if `seasonal` is chosen. Defaults to `auto`.
          enum:
          - auto
          - none
          - simple
          - seasonal
          type: string
          x-versionadded: v2.9
        disableHoldout:
          default: false
          description: Whether to suppress allocating a holdout fold. If `disableHoldout`
            is set to true, `holdoutStartDate` and `holdoutDuration` must not be set.
          type: boolean
          x-versionadded: v2.8
        featureDerivationWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should end.
          maximum: 0
          type: integer
          x-versionadded: v2.8
        featureDerivationWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the past relative to the forecast point the feature derivation window
            should begin.
          maximum: 0
          type: integer
          x-versionadded: v2.8
        featureSettings:
          description: An array specifying per feature settings. Features can be left
            unspecified.
          items:
            $ref: '#/components/schemas/FeatureSetting'
          type: array
        forecastWindowEnd:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            end.
          minimum: 0
          type: integer
          x-versionadded: v2.8
        forecastWindowStart:
          description: For time series projects only. How many timeUnits of the datetimePartitionColumn
            into the future relative to the forecast point the forecast window should
            start.
          minimum: 0
          type: integer
          x-versionadded: v2.8
        gapDuration:
          description: The duration of the gap between holdout training and holdout
            scoring data. For time series projects, defaults to the duration of the
            gap between the end of the feature derivation window and the beginning
            of the forecast window. For OTV projects, defaults to a zero duration
            (P0Y0M0D).
          format: duration
          type: string
        holdoutDuration:
          description: The duration of holdout scoring data. When specifying `holdoutDuration`,
            `holdoutStartDate` must also be specified. This attribute cannot be specified
            when `disableHoldout` is true.
          format: duration
          type: string
        holdoutEndDate:
          description: The end date of holdout scoring data. When specifying `holdoutEndDate`,
            `holdoutStartDate` must also be specified. This attribute cannot be specified
            when `disableHoldout` is true.
          format: date-time
          type: string
        holdoutStartDate:
          description: The start date of holdout scoring data. When specifying `holdoutStartDate`,
            one of `holdoutEndDate` or `holdoutDuration` must also be specified. This
            attribute cannot be specified when `disableHoldout` is true.
          format: date-time
          type: string
        isHoldoutModified:
          description: A boolean value indicating whether holdout settings (start/end
            dates) have been modified by user.
          type: boolean
        modelSplits:
          default: 5
          description: 'Sets the cap on the number of jobs per model used when building
            models to control number of jobs in the queue. Higher number of modelSplits
            will allow for less downsampling leading to the use of more post-processed
            data. '
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.21
        multiseriesIdColumns:
          description: May be used only with time series projects. An array of the
            column names identifying  the series to which each row of the dataset
            belongs. Currently only one multiseries ID column is supported. See the
            :ref:`multiseries <multiseries>` section of the time series documentation
            for more context.
          items:
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.11
        numberOfBacktests:
          description: The number of backtests to use. If omitted, defaults to a positive
            value selected by the server based on the validation and gap durations.
          maximum: 20
          minimum: 1
          type: integer
        periodicities:
          description: A list of periodicities for time series projects only. For
            classification problems periodicities are not allowed. If this is provided,
            parameter 'differencing_method' will default to 'seasonal' if not provided
            or 'auto'.
          items:
            $ref: '#/components/schemas/Periodicity'
          type: array
        target:
          description: Name of the target column.
          type: string
          x-versionadded: v2.22
        treatAsExponential:
          description: For time series projects only. Used to specify whether to treat
            data as exponential trend and apply transformations like log-transform.
            For classification problems `always` is not allowed. Defaults to `auto`.
          enum:
          - auto
          - never
          - always
          type: string
          x-versionadded: v2.9
        unsupervisedMode:
          default: false
          description: A boolean value indicating whether an unsupervised project
            should be created.
          type: boolean
          x-versionadded: v2.20
        unsupervisedType:
          description: The type of unsupervised project. Only valid when `unsupervisedMode`
            is true. If `unsupervisedMode`, defaults to `anomaly`.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.23
        useCrossSeriesFeatures:
          default: false
          description: For multiseries projects only. Indicating whether to use cross-series
            features.
          type: boolean
          x-versionadded: v2.14
        useSupervisedFeatureReduction:
          default: true
          description: When true, during feature generation DataRobot runs a supervised
            algorithm that identifies those features with predictive impact on the
            target and builds feature lists using only qualifying features. Setting
            false can severely impact autopilot duration, especially for datasets
            with many features.
          type: boolean
        useTimeSeries:
          default: false
          description: A boolean value indicating whether a time series project should
            be created instead of a regular project which uses datetime partitioning.
          type: boolean
          x-versionadded: v2.8
        validationDuration:
          description: The default validation duration for all backtests. If the primary
            date/time feature in a time series project is irregular, you cannot set
            a default validation length. Instead, set each duration individually.
            For an OTV project setting the validation duration will always use regular
            partitioning. Omitting it will use irregular partitioning if the date/time
            feature is irregular.
          format: duration
          type: string
        windowsBasisUnit:
          description: For time series projects only. Indicates which unit is basis
            for feature derivation window and forecast window. Valid options are detected
            time unit or `ROW`. If omitted, the default value is detected time unit.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          type: string
          x-versionadded: v2.14
      required:
      - datetimePartitionColumn
      type: object
    OptimizedDatetimePartitioningList:
      properties:
        datetimePartitionColumn:
          description: The date column that will be used as a datetime partition column.
          type: string
        id:
          description: The ID of the datetime partitioning.
          type: string
        partitionData:
          $ref: '#/components/schemas/DatetimePartitioningResponse'
          description: The datetime partitioning configuration.
        target:
          description: The name of the target column.
          type: string
      required:
      - datetimePartitionColumn
      - id
      - partitionData
      - target
      type: object
    OptimizedDatetimePartitioningListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of datetime partitionings returned in order of creation.
          items:
            $ref: '#/components/schemas/OptimizedDatetimePartitioningList'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    OptionalCredentialId:
      properties:
        credentialId:
          description: The id of the credentials to use for the connection. If not
            given the default credentials for the connection will be used.
          type: string
          x-versionadded: v2.33
      type: object
    OptionalDRConnectorV1DataSource:
      properties:
        dataStoreId:
          description: Data store ID for this data source.
          type: string
          x-versionadded: v2.22
        path:
          description: Path to the dataset within whatever filesystem data source
            is using. For example, for S3 the path will look something like `/foldername/filename.csv`.
          type: string
          x-versionadded: v2.22
      type: object
    OptionalDatabaseQueryDataSource:
      properties:
        dataStoreId:
          description: Data store ID for this data source.
          type: string
        fetchSize:
          description: User-specified fetch size.
          maximum: 20000
          minimum: 1
          type: integer
        query:
          description: The user-specified SQL query. If this is used, then catalog,
            schema and table will not be used.
          maxLength: 64000
          type: string
      type: object
    OptionalDatabaseTableDataSource:
      properties:
        catalog:
          description: Catalog name in the database if supported.
          maxLength: 256
          type: string
        dataStoreId:
          description: Data store ID for this data source.
          type: string
        fetchSize:
          description: User-specified fetch size.
          maximum: 20000
          minimum: 1
          type: integer
        partitionColumn:
          description: The name of the partition column. It is needed to allow parallel
            execution for the 10GB+ projects.
          type: string
        schema:
          description: Schema associated with the table or view in the database if
            supported.
          maxLength: 256
          type: string
        table:
          description: Table or view name in the database.
          maxLength: 256
          type: string
      type: object
    OrganizationJob:
      properties:
        jobId:
          description: The identifier of the submitted job (unique within a project)
          type: string
        projectId:
          description: The project identifier associated with this job
          type: string
        projectOwnerUserId:
          description: Identifier the user that owns the project associated with the
            job
          type: string
        projectOwnerUsername:
          description: The username of the user that owns the project associated with
            the job
          type: string
        userId:
          description: Identifies the user that submitted the job
          type: string
        username:
          description: The username of the user that submitted the job
          type: string
      required:
      - jobId
      - projectId
      - projectOwnerUserId
      - projectOwnerUsername
      - userId
      - username
      type: object
    OrganizationJobListResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: List of the requested jobs
          items:
            $ref: '#/components/schemas/OrganizationJob'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    OrganizationListResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: List of the requested organizations.
          items:
            $ref: '#/components/schemas/OrganizationRetrieve'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    OrganizationRetrieve:
      properties:
        accountPermissions:
          additionalProperties:
            type: boolean
          description: Account permissions available to this organization. This will
            only be present if the corresponding feature flag is set.
          type: object
        agreementStatus:
          description: The status of the organization's agreement to the terms of
            DataRobot.
          enum:
          - NEEDED
          - AGREED
          - N/A
          type: string
        datasetRefreshJobLimit:
          description: How many enabled dataset refresh jobs are allowed per-dataset
            for this organization.
          nullable: true
          type: integer
        datasetRefreshJobUserLimit:
          description: How many enabled dataset refresh jobs are allowed per-user
            for this organization.
          nullable: true
          type: integer
        defaultUserMaxGpuWorkers:
          description: Maximum number of concurrent GPU workers assigned to a newly
            created user of this organization.
          nullable: true
          type: integer
        defaultUserMaxWorkers:
          description: Maximum number of concurrent workers assigned to a newly created
            user of this organization.
          nullable: true
          type: integer
        deleted:
          description: Indicates whether the organization is soft-deleted.
          nullable: true
          type: boolean
        deletedAt:
          description: Indicates when the organization was soft-deleted.
          format: date-time
          nullable: true
          type: string
        deletedBy:
          description: Indicates who has soft-deleted the organization.
          nullable: true
          type: string
        desiredCustomModelContainerSize:
          description: The desired custom-model memory size. This will only be present
            if the corresponding feature flag is set.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        enableSso:
          description: If the SSO is enabled for this organization. This will only
            be present if the corresponding feature flag is set.
          type: boolean
        groupsCount:
          description: The number of user groups belonging to this organization.
          type: integer
          x-versionadded: v2.17
        id:
          description: The organization identifier.
          type: string
        inactiveUsersCount:
          description: The number of inactive users for this organization.
          type: integer
          x-versionadded: v2.21
        maxCodespaces:
          description: Maximum number of codespaces available to this organization.
          nullable: true
          type: integer
        maxConcurrentBatchPredictionsJob:
          description: Maximum number of concurrent batch prediction jobs to this
            organization
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        maxConcurrentNotebooks:
          description: Maximum number of concurrent notebooks available to this organization.
          nullable: true
          type: integer
        maxCustomModelContainerSize:
          description: The maximum memory that might be allocated by the custom-model.
            This will only be present if the corresponding feature flag is set.
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        maxCustomModelReplicasPerDeployment:
          description: A fixed number of replicas that will be set for the given custom-model.
            This will only be present if the corresponding feature flag is set.
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
        maxCustomModelReplicasPerDeploymentForBatchPredictions:
          description: The maximum custom inference model replicas per deployment
            for batch predictions. This will only be present if the corresponding
            feature flag is set.
          maximum: 8
          minimum: 1
          nullable: true
          type: integer
        maxDailyBatchesPerDeployment:
          description: The maximum number of monitoring batches that can be created
            per day on deployments that belong to this organization.
          minimum: 1
          nullable: true
          type: integer
        maxDeploymentLimit:
          description: The absolute limit on the number of deployments an organization
            is allowed to create. A value of zero means unlimited.
          type: integer
          x-versionadded: v2.21
        maxEdaWorkers:
          description: Maximum number of EDA workers assigned available to this organization.
          nullable: true
          type: integer
        maxEnabledNotebookSchedules:
          description: Maximum number of enabled notebook schedules for this organization.
          minimum: 1
          nullable: true
          type: integer
        maxExecutionEnvironments:
          description: The upper limit for the number of maximum execution environments.
            The limit is defined if the group is part of an organization, and the
            attribute is set on the organization level.
          minimum: 0
          nullable: true
          type: integer
        maxGpuWorkers:
          description: Maximum number of concurrent GPU workers available to this
            organization.
          nullable: true
          type: integer
        maxLlmApiCalls:
          description: Maximum number of LLM calls.
          minimum: 1
          nullable: true
          type: integer
        maxNotebookMachineSize:
          description: Maximum size of notebook machine available to this organization.
          enum:
          - L
          - M
          - S
          - XS
          nullable: true
          type: string
        maxNotebookSchedulingWorkers:
          description: Maximum number of concurrently running notebooks schedules
            for this organization.
          maximum: 20
          minimum: 1
          nullable: true
          type: integer
        maxPipelineModuleRuntimes:
          description: Maximum number of Pipeline module runtimes available to this
            organization.
          nullable: true
          type: integer
        maxUploadSize:
          description: Maximum size for file uploads (MB). This will only be present
            if the corresponding feature flag is set.
          nullable: true
          type: integer
        maxUploadSizeCatalog:
          description: Maximum size for catalog file uploads (MB). This will only
            be present if the corresponding feature flag is set.
          nullable: true
          type: integer
        maxVectorDatabases:
          description: Maximum number of local vector databases.
          minimum: 1
          nullable: true
          type: integer
        maxWorkers:
          description: Maximum number of concurrent workers available to this organization.
          nullable: true
          type: integer
        maximumActiveUsers:
          description: The limit for active users for this organization. A value of
            zero means unlimited.
          type: integer
          x-versionadded: v2.21
        membersCount:
          description: The number of members in this organization.
          type: integer
        mlopsEventStorageRetentionDays:
          default: 0
          description: The number of days to keep MLOps events in storage. Events
            with older timestamps will be removed.
          minimum: 0
          type: integer
        name:
          description: The name of the organization.
          nullable: true
          type: string
        ormVersion:
          description: On-demand Resource Manager (prediction service provisioning)
            version.
          enum:
          - v1
          - v2
          - v3
          - CCM
          type: string
        permadeleted:
          description: Indicates whether the organization is permadeleted.
          nullable: true
          type: boolean
        permadeletedAt:
          description: Indicates when the organization was permadeleted.
          format: date-time
          nullable: true
          type: string
        permadeletedBy:
          description: Indicates who has permadeleted the organization.
          nullable: true
          type: string
        prepaidDeploymentLimit:
          description: The number of deployments an organization can create under
            their contract. When it is reached more deployments can be made, but the
            user will be warned that this will result in a higher billing. A value
            of zero means unlimited.
          type: integer
          x-versionadded: v2.21
        restrictedSharing:
          description: Whether sharing is only allowed within the organization. This
            will only be present if the corresponding feature flag is set.
          type: boolean
        snapshotLimit:
          description: The number of snapshots allowed for a dataset for this organization.
          nullable: true
          type: integer
        supportEmail:
          description: The support email of the organization.
          nullable: true
          type: string
      required:
      - agreementStatus
      - datasetRefreshJobLimit
      - datasetRefreshJobUserLimit
      - defaultUserMaxGpuWorkers
      - defaultUserMaxWorkers
      - groupsCount
      - id
      - inactiveUsersCount
      - maxDeploymentLimit
      - maxEdaWorkers
      - maxExecutionEnvironments
      - maxGpuWorkers
      - maxLlmApiCalls
      - maxPipelineModuleRuntimes
      - maxVectorDatabases
      - maxWorkers
      - maximumActiveUsers
      - membersCount
      - name
      - ormVersion
      - prepaidDeploymentLimit
      - snapshotLimit
      - supportEmail
      type: object
    OrganizationUser:
      properties:
        accessRoleIds:
          description: List of access role ids assigned to the user being created
          items:
            type: string
          type: array
        create:
          default: false
          description: If the user should be created if not found
          type: boolean
        firstName:
          description: First name of the user being created
          maxLength: 100
          type: string
        language:
          description: Language selection for the user being created.
          enum:
          - ar_001
          - de_DE
          - en
          - es_419
          - fr
          - ja
          - ko
          - pt_BR
          - test
          - uk_UA
          type: string
        lastName:
          description: Last name of the user being created
          maxLength: 100
          type: string
        orgAdmin:
          default: false
          description: Is this user should be marked as an organizational admin
          type: boolean
          x-versionadded: v2.24
        password:
          description: Password for the user being created. Should be specified if
            `create` set to `true`
          maxLength: 512
          minLength: 8
          type: string
        requireClickthrough:
          default: false
          description: Require the user being created to agree to a clickthrough
          type: boolean
        username:
          description: The username of the user to add to the organization
          type: string
      required:
      - username
      type: object
    OrganizationUserCreatedResponse:
      properties:
        userId:
          description: ID of the user added to the organization
          type: string
      type: object
    OrganizationUserListResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: List of users in the organization.
          items:
            $ref: '#/components/schemas/OrganizationUserResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    OrganizationUserPatch:
      properties:
        accessRoleIds:
          description: List of access role ids assigned to the user
          items:
            type: string
          type: array
        activated:
          description: Whether the organization user is activated.
          type: boolean
        expirationDate:
          description: User expiration date
          format: date-time
          type: string
        maxWorkers:
          description: User max workers
          exclusiveMinimum: true
          minimum: 0
          type: integer
        orgAdmin:
          description: Mark user as an organizational admin
          type: boolean
        organizationId:
          description: Organization to move the user into (destination org).
          type: string
      type: object
    OrganizationUserResponse:
      properties:
        accessRoleIds:
          description: List of access role ids assigned to the user
          items:
            type: string
          type: array
        activated:
          description: Whether the organization user is activated.
          type: boolean
        expirationDate:
          description: User expiration date
          format: date-time
          nullable: true
          type: string
        externalId:
          description: The external user ID
          type: string
        firstName:
          description: First name of the user being created
          nullable: true
          type: string
        id:
          description: The organization user identifier.
          type: string
        lastName:
          description: Last name of the user being created
          nullable: true
          type: string
        maxWorkers:
          description: Maximum number of concurrent workers available to this user.
          type: integer
        orgAdmin:
          description: Is this user should be marked as an organizational admin
          type: boolean
          x-versionadded: v2.24
        organizationId:
          description: The organization identifier.
          type: string
        scheduledForDeletion:
          description: Whether the user is scheduled for deletion. Only set when a
            specific feature flag is configured.
          type: boolean
        username:
          description: The username of the user to add to the organization
          type: string
      required:
      - activated
      - expirationDate
      - externalId
      - firstName
      - id
      - lastName
      - maxWorkers
      - orgAdmin
      - organizationId
      - username
      type: object
    PPSImageMetadataResponse:
      properties:
        baseImageId:
          description: Internal base image entity id for troubleshooting purposes
          type: string
        created:
          description: ISO formatted image upload date
          format: date-time
          type: string
        datarobotRuntimeImageTag:
          description: For internal use only.
          nullable: true
          type: string
        dockerImageId:
          description: A Docker image id (immutable, content-based) hash associated
            with the given image
          type: string
        filename:
          description: The name of the file when the download requested
          type: string
        hash:
          description: Hash of the image content, supposed to be used for verifying
            content after the download. The algorithm used for hashing is specified
            in `hashAlgorithm` field. Note that hash is calculated over compressed
            image data.
          type: string
        hashAlgorithm:
          description: An algorithm name used for calculating content `hash`
          enum:
          - SHA256
          type: string
        imageSize:
          description: Size in bytes of the compressed PPS image data
          type: integer
        shortDockerImageId:
          description: A 12-chars shortened version of the `dockerImageId` as shown
            in 'docker images' command line command output
          type: string
      required:
      - baseImageId
      - created
      - dockerImageId
      - filename
      - hash
      - hashAlgorithm
      - imageSize
      - shortDockerImageId
      type: object
    PairwiseManualSelectionCreatePayload:
      properties:
        columnLabels:
          description: Manually selected column labels.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        featureName:
          description: Name of the feature the request is related to
          nullable: true
          type: string
        multilabelInsightsKey:
          description: Key for multilabel insights, unique per project, feature, and
            EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
            or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
          type: string
        name:
          description: Name for the set of manually selected labels.
          maxLength: 100
          type: string
        projectId:
          description: ID of the project the request is related to.
          nullable: true
          type: string
        rowLabels:
          description: Manually selected row labels.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - columnLabels
      - featureName
      - multilabelInsightsKey
      - name
      - projectId
      - rowLabels
      type: object
    PairwiseManualSelectionCreateResponse:
      properties:
        id:
          description: ID of the label set.
          type: string
      required:
      - id
      type: object
    PairwiseManualSelectionCreatedItem:
      properties:
        columnLabels:
          description: Manually selected column labels.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        id:
          description: Id of the manually selected labels set
          type: string
        name:
          description: Name for the set of manually selected labels.
          maxLength: 100
          type: string
        rowLabels:
          description: Manually selected row labels.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - columnLabels
      - id
      - name
      - rowLabels
      type: object
    PairwiseManualSelectionResponse:
      properties:
        manualSelectionId:
          description: ID of the deleted or updated label set.
          type: string
      required:
      - manualSelectionId
      type: object
    PairwiseManualSelectionUpdateRequest:
      properties:
        name:
          description: Name for the set of manually selected labels.
          maxLength: 100
          type: string
      required:
      - name
      type: object
    PairwiseManualSelectionsRetrieveResponse:
      properties:
        data:
          description: List of manually selected labels sets
          items:
            $ref: '#/components/schemas/PairwiseManualSelectionCreatedItem'
          type: array
        featureName:
          description: Name of the feature the request is related to
          nullable: true
          type: string
        multilabelInsightsKey:
          description: Key for multilabel insights, unique per project, feature, and
            EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
            or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
          type: string
        projectId:
          description: ID of the project the request is related to.
          nullable: true
          type: string
      required:
      - data
      - featureName
      - multilabelInsightsKey
      - projectId
      type: object
    PairwiseStatisticsItem:
      properties:
        labelConfiguration:
          description: Configuration of all labels.
          items:
            $ref: '#/components/schemas/PairwiseStatisticsLabelConfiguration'
          maxItems: 2
          minItems: 2
          type: array
        statisticValue:
          description: Statistic value for the given label configuration.
          nullable: true
          type: number
      required:
      - labelConfiguration
      - statisticValue
      type: object
    PairwiseStatisticsLabelConfiguration:
      properties:
        label:
          description: Label name.
          type: string
        relevance:
          description: Relevance value of the label.
          maximum: 1
          minimum: 0
          type: integer
      required:
      - label
      type: object
    PairwiseStatisticsResponse:
      properties:
        data:
          description: Statistic values.
          items:
            $ref: '#/components/schemas/PairwiseStatisticsItem'
          type: array
        featureName:
          description: Feature name.
          type: string
        projectId:
          description: Project Id.
          maxLength: 24
          minLength: 24
          type: string
        statisticType:
          description: Pairwise statistic type.
          enum:
          - conditionalProbability
          - correlation
          - jointProbability
          type: string
      required:
      - data
      - featureName
      - projectId
      - statisticType
      type: object
    ParamValuePair:
      properties:
        param:
          description: The name of a field associated with the value.
          type: string
        value:
          description: Any value.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
      required:
      - param
      - value
      type: object
    Parameters:
      properties:
        name:
          description: The name of the parameter identifying what it means for the
            model, e.g. "Intercept".
          type: string
        value:
          description: The value of the parameter.
          type: string
      required:
      - name
      - value
      type: object
    ParetoFrontResponse:
      properties:
        errorMetric:
          description: The Eureqa error metric identifier used to compute error metrics
            for this search. Note that Eureqa error metrics do not correspond 1:1
            with DataRobot error metrics - the available metrics are not the same,
            and even equivalent metrics may be computed slightly differently.
          type: string
        hyperparameters:
          description: The hyperparameters used by this run of the Eureqa blueprint.
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/HyperparametersResponse'
        projectId:
          description: The project ID of the Eureqa model.
          type: string
        solutions:
          description: The Eureqa model solutions.
          items:
            $ref: '#/components/schemas/SolutionResponse'
          type: array
        targetType:
          description: The type of the target variable.
          enum:
          - Regression
          - Binary
          type: string
      required:
      - errorMetric
      - hyperparameters
      - projectId
      - solutions
      - targetType
      type: object
    PartialDependence:
      properties:
        data:
          description: Partial dependence results.
          items:
            $ref: '#/components/schemas/PartialDependenceData'
          type: array
        isCapped:
          description: Indicates whether the data for computation is capped.
          type: boolean
      required:
      - data
      - isCapped
      type: object
    PartialDependenceData:
      properties:
        dependence:
          description: The value of partial dependence.
          type: number
        label:
          description: Contains the label for categorical and numeric features as
            string.
          type: string
      required:
      - dependence
      - label
      type: object
    Partition:
      properties:
        cvHoldoutLevel:
          description: If a user partition column was used with cross validation,
            the value assigned to the holdout set
          nullable: true
          type: string
        cvMethod:
          description: The partitioning method used. Note that "date" partitioning
            is an old partitioning method no longer supported for new projects, as
            of API version v2.0.
          enum:
          - random
          - stratified
          - datetime
          - user
          - group
          - date
          type: string
        datetimeCol:
          description: If a date partition column was used, the name of the column.
            Note that datetimeCol applies to an old partitioning method no longer
            supported for new projects, as of API version v2.0.
          nullable: true
          type: string
        datetimePartitionColumn:
          description: If a datetime partition column was used, the name of the column.
          nullable: true
          type: string
        holdoutLevel:
          description: If a user partition column was used with train-validation-holdout
            split, the value assigned to the holdout set.
          nullable: true
          type: string
        holdoutPct:
          description: The percentage of the dataset reserved for the holdout set.
          nullable: true
          type: number
        partitionKeyCols:
          description: An array containing a single string - the name of the group
            partition column
          items:
            type: string
          nullable: true
          type: array
        reps:
          description: If cross validation was used, the number of folds to use.
          nullable: true
          type: integer
        trainingLevel:
          description: If a user partition column was used with train-validation-holdout
            split, the value assigned to the training set.
          nullable: true
          type: string
        useTimeSeries:
          description: Indicates whether a time series project was created as opposed
            to a regular project using datetime partitioning.
          nullable: true
          type: boolean
          x-versionadded: v2.9
        userPartitionCol:
          description: If a user partition column was used, the name of the column.
          nullable: true
          type: string
        validationLevel:
          description: If a user partition column was used with train-validation-holdout
            split, the value assigned to the validation set.
          nullable: true
          type: string
        validationPct:
          description: If train-validation-holdout split was used, the percentage
            of the dataset used for the validation set.
          nullable: true
          type: number
        validationType:
          description: The type of validation used.  Either CV (cross validation)
            or TVH (train-validation-holdout split).
          enum:
          - CV
          - TVH
          type: string
      required:
      - cvHoldoutLevel
      - cvMethod
      - datetimeCol
      - holdoutLevel
      - holdoutPct
      - partitionKeyCols
      - reps
      - trainingLevel
      - userPartitionCol
      - validationLevel
      - validationPct
      - validationType
      type: object
    PartitioningExtendedWarning:
      properties:
        backtestIndex:
          description: Backtest index. Null if the warning does not correspond to
            a single backtest.
          nullable: true
          type: integer
        partition:
          description: Partition name.
          type: string
        warnings:
          description: A list of strings representing warnings for the specified partition
          items:
            $ref: '#/components/schemas/PartitioningSingleExtendedWarning'
          type: array
      required:
      - backtestIndex
      - partition
      - warnings
      type: object
    PartitioningSingleExtendedWarning:
      properties:
        message:
          description: Warning message.
          type: string
        title:
          description: Warning short title.
          type: string
        type:
          description: Warning severity type.
          type: string
      required:
      - message
      - title
      - type
      type: object
    PartitioningWarning:
      properties:
        backtestIndex:
          description: Backtest index. Null if the warning does not correspond to
            a single backtest.
          nullable: true
          type: integer
        partition:
          description: Partition name.
          type: string
        warnings:
          description: A list of strings representing warnings for the specified partition
          items:
            type: string
          type: array
      required:
      - backtestIndex
      - partition
      - warnings
      type: object
    PasswordCredentials:
      properties:
        catalogVersionId:
          description: The ID of the latest version of the catalog entry.
          type: string
        password:
          description: The password (in cleartext) for database authentication. The
            password will be encrypted on the server side in scope of HTTP request
            and never saved or stored.
          type: string
        url:
          description: The link to retrieve more detailed information about the entity
            that uses this catalog dataset.
          type: string
        user:
          description: The username for database authentication.
          type: string
      required:
      - password
      - user
      type: object
    PatchDataset:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
            If any categories were previously specified for the dataset, they will
            be overwritten.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        name:
          description: The new name of the dataset.
          type: string
      type: object
    PatchRecipe:
      properties:
        description:
          description: New recipe description.
          maxLength: 1000
          type: string
          x-versionadded: v2.33
        name:
          description: New recipe name.
          maxLength: 255
          type: string
          x-versionadded: v2.33
      type: object
    PayoffMatricesCreate:
      properties:
        falseNegativeValue:
          description: False negative value to use for profit curve calculation.
          type: number
        falsePositiveValue:
          description: False positive value to use for profit curve calculation.
          type: number
        name:
          description: Name of the payoff matrix to be created.
          type: string
        trueNegativeValue:
          description: True negative value to use for profit curve calculation.
          type: number
        truePositiveValue:
          description: True positive value to use for profit curve calculation.
          type: number
      required:
      - falseNegativeValue
      - falsePositiveValue
      - name
      - trueNegativeValue
      - truePositiveValue
      type: object
    PayoffMatricesListResponse:
      properties:
        count:
          description: Number of items in current page.
          type: integer
        data:
          description: Payoff matrices for a project.
          items:
            $ref: '#/components/schemas/PayoffMatricesResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: Total number of items.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    PayoffMatricesResponse:
      properties:
        falseNegativeValue:
          description: Payoff value for false negatives used in profit curve calculation.
          type: number
        falsePositiveValue:
          description: Payoff value for false positives used in profit curve calculation.
          type: number
        id:
          description: ObjectId of the payoff matrix.
          type: string
        name:
          description: Label for the payoff matrix.
          type: string
        projectId:
          description: ID of the project associated with the payoff matrix.
          type: string
        trueNegativeValue:
          description: Payoff value for true negatives used in profit curve calculation.
          type: number
        truePositiveValue:
          description: Payoff value for true positives used in profit curve calculation.
          type: number
      required:
      - falseNegativeValue
      - falsePositiveValue
      - id
      - name
      - projectId
      - trueNegativeValue
      - truePositiveValue
      type: object
    PerClassAccuracy:
      properties:
        className:
          description: The name of the class value for the categorical feature.
          type: string
        metrics:
          description: An array of metric scores.
          items:
            $ref: '#/components/schemas/AccuracyMetrics'
          type: array
      required:
      - className
      - metrics
      type: object
    PerClassFairness:
      properties:
        absoluteValue:
          description: Absolute fairness score for the class
          minimum: 0.0
          type: number
        className:
          description: Name of the protected class the score is calculated for.
          type: string
        entriesCount:
          description: The number of entries of the class in the analysed data.
          minimum: 0
          type: integer
        isStatisticallySignificant:
          description: Flag to tell whether the score can be treated as statistically
            significant. In other words, whether we are confident enough with the
            score for this protected class.
          type: boolean
        value:
          description: The relative fairness score for the class.
          maximum: 1.0
          minimum: 0.0
          type: number
      required:
      - absoluteValue
      - className
      - entriesCount
      - isStatisticallySignificant
      - value
      type: object
    PerClusterCategorical:
      properties:
        allOther:
          description: A percentage of rows that do not have any of these values or
            categories.
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        clusterName:
          description: Cluster name.
          type: string
        missingRowsPercent:
          description: A percentage of all rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        perValueStatistics:
          description: Statistic value for feature values in all data or a cluster.
          items:
            $ref: '#/components/schemas/PerValueStatisticsListItem'
          type: array
      required:
      - clusterName
      - perValueStatistics
      type: object
    PerClusterGeospatial:
      properties:
        clusterName:
          description: Cluster name.
          maxLength: 50
          minLength: 1
          type: string
        representativeLocations:
          description: A list of latitude and longitude location list
          items:
            description: Latitude and longitude list.
            items:
              description: Longitude or latitude, in degrees.
              maximum: 180
              minimum: -180
              type: number
            type: array
          maxItems: 1000
          type: array
      required:
      - clusterName
      - representativeLocations
      type: object
    PerClusterImage:
      properties:
        clusterName:
          description: Cluster name.
          type: string
        images:
          description: A list of b64 encoded images.
          items:
            description: b64 encoded image
            type: string
          type: array
        percentageOfMissingImages:
          description: A percentage of image rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          type: number
      required:
      - clusterName
      - images
      - percentageOfMissingImages
      type: object
    PerClusterNumeric:
      properties:
        clusterName:
          description: Cluster name.
          type: string
        statistic:
          description: Statistic value for this cluster.
          nullable: true
          type: number
      required:
      - clusterName
      - statistic
      type: object
    PerClusterText:
      properties:
        clusterName:
          description: Cluster name.
          type: string
        missingRowsPercent:
          description: A percentage of all rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        perValueStatistics:
          description: Statistic value for feature values in all data or a cluster.
          items:
            $ref: '#/components/schemas/PerValueStatisticTextListItem'
          type: array
      required:
      - clusterName
      - perValueStatistics
      type: object
    PerFeatureMissingReport:
      properties:
        feature:
          description: The name of the feature
          type: string
        missingCount:
          description: The number of missing values in the training data
          type: integer
        missingPercentage:
          description: The percentage of missing values in the training data
          maximum: 1.0
          minimum: 0.0
          type: number
        tasks:
          additionalProperties:
            $ref: '#/components/schemas/PerFeatureTaskMissingReport'
          description: Information on individual tasks of the model which were used
            to process the feature. The names of properties will be task ids (which
            correspond to the ids used in the blueprint chart endpoints like :http:get:`/api/v2/projects/(projectId)/blueprints/(blueprintId)/blueprintChart/`)
            The corresponding value for each task will be of the form `task` described.
          type: object
        type:
          description: The type of the feature, e.g. `Categorical` or `Numeric`
          type: string
      required:
      - feature
      - missingCount
      - missingPercentage
      - tasks
      - type
      type: object
    PerFeatureTaskMissingReport:
      properties:
        descriptions:
          description: 'Human readable aggregated information about how the task handles
            missing values. The following descriptions may be present: what value
            is imputed for missing values, whether the feature being missing is treated
            as a feature by the task, whether missing values are treated as infrequent
            values, whether infrequent values are treated as missing values, and whether
            missing values are ignored.'
          items:
            type: string
          type: array
        name:
          description: Task name, e.g. 'Ordinal encoding of categorical variables'
          type: string
      required:
      - descriptions
      - name
      type: object
    PerNgramTextExplanations:
      properties:
        isUnknown:
          description: Whether the ngram is identifiable by the blueprint or not.
          type: boolean
          x-versionadded: v2.28
        ngrams:
          description: List of JSON objects with the ngram starting index, ngram ending
            index and unknown ngram information.
          items:
            $ref: '#/components/schemas/PredictionExplanationsPredictionValues'
          maxItems: 1000
          type: array
          x-versionadded: v2.28
        qualitativateStrength:
          description: A human-readable description of how strongly these ngrams's
            affected the prediction(e.g. '+++', '--', '+', '<+', '<-').
          type: string
          x-versionadded: v2.28
        strength:
          description: The amount these ngrams's affected the prediction.
          type: number
          x-versionadded: v2.28
      required:
      - isUnknown
      - ngrams
      - qualitativateStrength
      - strength
      type: object
    PerValueStatisticTextListItem:
      properties:
        contextualExtracts:
          description: Contextual extracts that show context for the n-gram.
          items:
            type: string
          type: array
        importance:
          description: Importance value for this n-gram.
          type: number
        ngram:
          description: An n-gram.
          type: string
      required:
      - contextualExtracts
      - importance
      - ngram
      type: object
    PerValueStatistics:
      properties:
        allOther:
          description: A percentage of rows that do not have any of these values or
            categories.
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        missingRowsPercent:
          description: A percentage of all rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          nullable: true
          type: number
        perValueStatistics:
          description: Statistic value for feature values in all data or a cluster.
          items:
            $ref: '#/components/schemas/PerValueStatisticsListItem'
          type: array
      required:
      - perValueStatistics
      type: object
    PerValueStatisticsListItem:
      properties:
        categoryLevel:
          description: A category level.
          type: string
        frequency:
          description: Statistic value for this cluster.
          type: number
      required:
      - categoryLevel
      - frequency
      type: object
    Percentile:
      properties:
        percent:
          description: Percent of the percentile
          type: number
        value:
          description: Predicted value or probability at a percentile
          type: number
      required:
      - percent
      - value
      type: object
    Periodicity:
      properties:
        timeSteps:
          description: The number of time steps.
          minimum: 0
          type: integer
        timeUnit:
          description: The time unit or `ROW` if windowsBasisUnit is `ROW`
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          - ROW
          type: string
      required:
      - timeSteps
      - timeUnit
      type: object
    PermutationFeatureImpactCreatePayload:
      properties:
        backtest:
          description: The backtest value used for Feature Impact computation. Applicable
            for datetime aware models.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
          x-versionadded: v2.28
        rowCount:
          description: The sample size to use for Feature Impact computation. It is
            possible to re-compute Feature Impact with a different row count.
          maximum: 100000
          minimum: 10
          type: integer
          x-versionadded: v2.21
      type: object
    PermutationFeatureImpactResponse:
      properties:
        backtest:
          description: The backtest model used to compute Feature Impact.Defined for
            datetime aware models.
          nullable: true
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
          x-versionadded: v2.29
        count:
          description: Number of feature impact records in a given batch.
          type: integer
        featureImpacts:
          description: A list which contains feature impact scores for each feature
            used by a model. If the model has more than 1000 features, the most important
            1000 features are returned.
          items:
            $ref: '#/components/schemas/FeatureImpactItem'
          maxItems: 1000
          type: array
        next:
          description: URL for the next page of results or `null`.
          format: uri
          nullable: true
          type: string
        previous:
          description: URL for the next page of results or `null`.
          format: uri
          nullable: true
          type: string
        ranRedundancyDetection:
          description: Indicates whether redundant feature identification was run
            while calculating this feature impact.
          type: boolean
        rowCount:
          description: The number of rows that was used to calculate feature impact.
            For the feature impact calculated with the default logic, without specifying
            the ``rowCount``, we return ``null`` here.
          nullable: true
          type: integer
          x-versionadded: v2.21
        shapBased:
          description: 'Indicates whether feature impact was calculated using Shapley
            values. True for anomaly detection models when the project is unsupervised,
            as permutation approach is not applicable. Note that supervised projects
            must use an alternative route for SHAP impact: /api/v2/projects/(projectId)/models/(modelId)/shapImpact/'
          type: boolean
          x-versionadded: v2.18
      required:
      - backtest
      - count
      - featureImpacts
      - next
      - previous
      - ranRedundancyDetection
      - rowCount
      - shapBased
      type: object
    PersistentLogsForModelWithCustomTasksRetrieveResponse:
      properties:
        data:
          description: An archive (tar.gz) of the logs produced and persisted by a
            model.
          format: binary
          type: string
      required:
      - data
      type: object
    PlotDataResponse:
      properties:
        actual:
          description: The actual value of the target variable for the specified row.
          type: number
        predicted:
          description: The predicted value of the target by the solution for the specified
            row.
          type: number
        row:
          description: The row number from the raw source data. Used as the X axis
            for the plot when rendered in the web application.
          type: integer
      required:
      - actual
      - predicted
      - row
      type: object
    PolicyUserGroup:
      properties:
        id:
          description: ID of the user group.
          type: string
        name:
          description: Name of the user group.
          maxLength: 50
          nullable: true
          type: string
      required:
      - id
      type: object
    PredictJobDetailsResponse:
      properties:
        id:
          description: the job ID of the job
          type: string
        isBlocked:
          description: True if a job is waiting for its dependencies to be resolved
            first.
          type: boolean
        message:
          description: An optional message about the job
          type: string
        modelId:
          description: The ID of the model
          type: string
        projectId:
          description: the project the job belongs to
          type: string
        status:
          description: the status of the job
          enum:
          - queue
          - inprogress
          - error
          - ABORTED
          - COMPLETED
          type: string
      required:
      - id
      - isBlocked
      - message
      - modelId
      - projectId
      - status
      type: object
    PredictedClassDistribution:
      properties:
        className:
          description: Name of the class.
          type: string
        count:
          description: Count of prediction rows labeled with a class in the bucket.
          type: integer
        percent:
          description: Percent of prediction rows labeled with a class in the bucket.
          type: number
      required:
      - className
      - count
      - percent
      type: object
    PredictedFrequency:
      properties:
        otherClassName:
          description: The name of the class.
          type: string
        percentage:
          description: the percentage of the times this class was actual when `classMetrics.className`
            is predicted (from 0 to 100)
          maximum: 100
          minimum: 0
          type: number
        value:
          description: The count of the times this class was actual `classMetrics.className`
            when it was predicted
          minimum: 0
          type: integer
      required:
      - otherClassName
      - percentage
      - value
      type: object
    PredictedPercentages:
      properties:
        otherClassName:
          description: the name of the class
          type: string
        percentage:
          description: the percentage of the times this class was actual when `classMetrics.className`
            is predicted
          type: number
      required:
      - otherClassName
      - percentage
      type: object
    PredictedVsActual:
      properties:
        data:
          description: Predicted versus actual results.
          items:
            $ref: '#/components/schemas/PredictedVsActualData'
          type: array
        isCapped:
          description: Indicates whether the data for computation is capped.
          type: boolean
        logScaledData:
          description: Predicted versus actual results in a log scale.
          items:
            $ref: '#/components/schemas/PredictedVsActualData'
          type: array
      required:
      - data
      - isCapped
      - logScaledData
      type: object
    PredictedVsActualData:
      properties:
        actual:
          description: Actual value. `null` for 0 rows bins and unsupervised time
            series models.
          nullable: true
          type: number
        bin:
          description: For numeric features contains labels for left and right bin
            limits
          items:
            type: string
          type: array
        label:
          description: Contains label for categorical features; For numeric features
            contains range or numeric value.
          type: string
        predicted:
          description: Predicted value. `null` for 0 rows bins.
          nullable: true
          type: number
        rowCount:
          description: Number of rows for the label and bin.
          type: integer
      required:
      - actual
      - label
      - predicted
      - rowCount
      type: object
    PredictionArrayObjectValues:
      properties:
        label:
          description: For regression problems this will be the name of the target
            column, 'Anomaly score' or ignored field. For classification projects
            this will be the name of the class.
          oneOf:
          - type: string
          - type: number
        threshold:
          description: Threshold used in multilabel classification for this class.
          maximum: 1.0
          minimum: 0.0
          type: number
        value:
          description: The predicted probability of the class identified by the label.
          type: number
      required:
      - label
      - value
      type: object
    PredictionColumMap:
      properties:
        className:
          description: Class name.
          type: string
        columnName:
          description: Column name that contains the prediction for a specific class.
          type: string
      required:
      - className
      - columnName
      type: object
    PredictionDataBatch:
      properties:
        batchId:
          description: An ID of a batch.
          type: string
          x-versionadded: v2.33
        batchName:
          description: A name of a batch.
          type: string
          x-versionadded: v2.33
      required:
      - batchId
      - batchName
      type: object
    PredictionDataEntry:
      properties:
        id:
          description: The ID of the AI Catalog entry.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the AI Catalog entry.
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      type: object
    PredictionDataSource:
      properties:
        actualValueColumn:
          description: The actual value column name, valid for the prediction files
            if the project is unsupervised and the dataset is considered as bulk predictions
            dataset.
          type: string
          x-versionadded: v2.21
        credentialData:
          description: The credentials to authenticate with the database, to use instead
            of user/password or credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          x-versionadded: v2.23
        credentialId:
          description: The credential ID to use for database authentication.
          type: string
          x-versionadded: v2.19
        credentials:
          description: A list of credentials for the secondary datasets used in feature
            discovery project.
          items:
            oneOf:
            - $ref: '#/components/schemas/PasswordCredentials'
            - $ref: '#/components/schemas/CredentialId'
          maxItems: 30
          type: array
          x-versionadded: v2.19
        dataSourceId:
          description: The ID of ``DataSource``.
          type: string
        forecastPoint:
          description: For time series projects only. The time in the dataset relative
            to which predictions are generated. This value is optional. If not specified
            the default value is the value in the row with the latest specified timestamp.
            Specifying this value for a project that is not a time series project
            will result in an error.
          format: date-time
          type: string
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server side in scope of HTTP request
            and never saved or stored. DEPRECATED: please use ``credentialId`` or
            ``credentialData`` instead.'
          type: string
          x-versiondeprecated: v2.23
        predictionsEndDate:
          description: The end date for bulk predictions, exclusive. Used for time
            series projects only. Note that this parameter is used for generating
            historical predictions using the training data, not for future predictions.
            If not specified, the dataset is not considered as a bulk predictions
            dataset. This parameter should be provided in conjunction with a ``predictionsStartDate``,
            and cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        predictionsStartDate:
          description: The start date for bulk predictions. Used for time series projects
            only. Note that this parameter is used for generating historical predictions
            using the training data, not for future predictions. If not specified,
            the dataset is not considered as a bulk predictions dataset. This parameter
            should be provided in conjunction with a ``predictionsEndDate``, and cannot
            be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          description: For time series projects only. If true, missing values in the
            known in advance features are allowed in the forecast window at the prediction
            time. This value is optional. If omitted or false, missing values are
            not allowed.
          type: boolean
          x-versionadded: v2.15
        secondaryDatasetsConfigId:
          description: For feature discovery projects only. The ID of the alternative
            secondary dataset config to use during prediction.
          type: string
          x-versionadded: v2.19
        useKerberos:
          default: false
          description: If true, use kerberos authentication for database authentication.
            Default is false.
          type: boolean
          x-versionadded: v2.19
        user:
          description: 'The username for database authentication. DEPRECATED: please
            use ``credentialId`` or ``credentialData`` instead.'
          type: string
          x-versiondeprecated: v2.23
      required:
      - dataSourceId
      type: object
    PredictionDataTimeRange:
      properties:
        end:
          description: End of the period of prediction data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
        start:
          description: Start of the period of prediction data to collect.
          format: date-time
          type: string
          x-versionadded: v2.33
      required:
      - end
      - start
      type: object
    PredictionDataUpdate:
      properties:
        status:
          description: A prediction data export processing state.
          enum:
          - CANCELLED
          type: string
          x-versionadded: v2.33
      type: object
    PredictionDatasetAssignment:
      properties:
        datasetId:
          description: the ID of the dataset
          type: string
        datasetVersionId:
          description: the ID of the dataset version
          type: string
      required:
      - datasetId
      type: object
    PredictionDatasetListControllerResponse:
      properties:
        count:
          description: The number of items returned on this page.
          minimum: 0
          type: integer
        data:
          description: Each has the same schema as if retrieving the dataset individually
            from :http:get:`/api/v2/projects/(projectId)/predictionDatasets/(datasetId)/`
          items:
            $ref: '#/components/schemas/PredictionDatasetRetrieveResponse'
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    PredictionDatasetRetrieveResponse:
      properties:
        actualValueColumn:
          description: Optional, only available for unsupervised projects, in case
            dataset was uploaded with actual value column specified. Name of the column
            which will be used to calculate the classification metrics and insights.
          nullable: true
          type: string
          x-versionadded: v2.21
        catalogId:
          description: The ID of the AI catalog entry used to create the prediction,
            dataset or None if not created from the AI catalog.
          nullable: true
          type: string
          x-versionadded: v2.21
        catalogVersionId:
          description: The ID of the AI catalog version used to create the prediction
            dataset, or None if not created from the AI catalog.
          nullable: true
          type: string
          x-versionadded: v2.21
        containsTargetValues:
          description: If True, dataset contains target values and can be used to
            calculate the classification metrics and insights. Only applies for supervised
            projects.
          nullable: true
          type: boolean
          x-versionadded: v2.21
        created:
          description: The date string of when the dataset was created, of the format`YYYY-mm-ddTHH:MM:SS.ssssssZ`,
            like ``2016-06-09T11:32:34.170338Z``.
          format: date-time
          type: string
        dataEndDate:
          description: Only available for time series projects, a date string representing
            the maximum primary date of the prediction dataset.
          format: date-time
          type: string
          x-versionadded: v2.20
        dataQualityWarnings:
          $ref: '#/components/schemas/DataQualityWarningsRecord'
          description: A Json object of available warnings about potential problems
            in this prediction dataset. Empty if no warnings.
          nullable: true
          x-versionadded: v2.15
        dataStartDate:
          description: Only available for time series projects, a date string representing
            the minimum primary date of the prediction dataset.
          format: date-time
          type: string
          x-versionadded: v2.20
        detectedActualValueColumns:
          description: Only available for unsupervised projects, a list of detected
            `actualValueColumnInfo` objects which can be used to calculate the classification
            metrics and insights.
          items:
            $ref: '#/components/schemas/ActualValueColumnInfo'
          type: array
          x-versionadded: v2.21
        forecastPoint:
          description: The date string of the forecastPoint of this prediction dataset.
            Only non-null for time series projects.
          nullable: true
          type: string
          x-versionadded: v2.8
        forecastPointRange:
          description: Only available for time series projects, the start and end
            of the range of dates available for use as the forecast point, detected
            based on the uploaded prediction dataset.
          items:
            description: Date string of a forecast point.
            format: date-time
            type: string
          type: array
          x-versionadded: v2.20
        id:
          description: The ID of this dataset.
          type: string
        maxForecastDate:
          description: Only available for time series projects, a date string representing
            the maximum forecast date of this prediction dataset.
          format: date-time
          type: string
          x-versionadded: v2.20
        name:
          description: The name of the dataset when it was uploaded.
          type: string
        numColumns:
          description: The number of columns in this dataset.
          type: integer
        numRows:
          description: The number of rows in this dataset.
          type: integer
        predictionsEndDate:
          description: The date string of the prediction end date of this prediction
            dataset. Used for bulk predictions. Note that this parameter is for generating
            historical predictions using the training data. Only non-null for time
            series projects.
          format: date-time
          nullable: true
          type: string
        predictionsStartDate:
          description: The date string of the prediction start date of this prediction
            dataset. Used for bulk predictions. Note that this parameter is for generating
            historical predictions using the training data. Only non-null for time
            series projects.
          format: date-time
          nullable: true
          type: string
        projectId:
          description: The project ID that owns this dataset.
          type: string
        secondaryDatasetsConfigId:
          description: Only available for Feature discovery projects. Id of the secondary
            dataset config used by the dataset for the prediction.
          type: string
          x-versionadded: v2.21
      required:
      - catalogId
      - catalogVersionId
      - created
      - dataQualityWarnings
      - forecastPoint
      - id
      - name
      - numColumns
      - numRows
      - predictionsEndDate
      - predictionsStartDate
      - projectId
      type: object
    PredictionEnvironment:
      properties:
        id:
          description: ID of the prediction environment.
          type: string
        name:
          description: Name of the prediction environment.
          type: string
      required:
      - id
      - name
      type: object
    PredictionEnvironmentResponse:
      properties:
        id:
          description: ID of the prediction environment.
          type: string
        name:
          description: Name of the prediction environment.
          type: string
      required:
      - id
      - name
      type: object
    PredictionExplanation:
      properties:
        feature:
          description: The name of the feature contributing to the prediction.
          type: string
        featureValue:
          description: The value the feature took on for this row. For image features,
            this value is the URL of the input image (New in v2.21).
          type: string
        imageExplanationUrl:
          description: For image features, the URL of the image containing the input
            image overlaid by the activation heatmap. For non-image features, this
            field is null.
          nullable: true
          type: string
          x-versionadded: v2.21
        label:
          description: Describes what this model output corresponds to. For regression
            projects, it is the name of the target feature. For classification projects,
            it is a level from the target feature. For Anomaly Detection models it
            is an Anomaly Score.
          type: string
        perNgramTextExplanations:
          description: For text features, an array of JSON object containing the per
            ngram based text prediction explanations.
          items:
            $ref: '#/components/schemas/PerNgramTextExplanations'
          maxItems: 10000
          type: array
          x-versionadded: v2.28
        qualitativateStrength:
          description: A human-readable description of how strongly the feature affected
            the prediction (e.g. '+++', '--', '+', '<+', '<-').
          type: string
        strength:
          description: The amount this feature's value affected the prediction.
          type: number
      required:
      - feature
      - featureValue
      - imageExplanationUrl
      - label
      - qualitativateStrength
      - strength
      type: object
    PredictionExplanationsCreate:
      properties:
        classNames:
          description: List of class names that will be explained for each row for
            multiclass. Mutually exclusive with numTopClasses. If neither specified
            - we assume numTopClasses=1.
          items:
            type: string
          maxItems: 10
          type: array
          x-versionadded: v2.29
        datasetId:
          description: The dataset ID.
          type: string
        maxExplanations:
          default: 3
          description: The maximum number of prediction explanations to supply per
            row of the dataset.
          maximum: 10
          minimum: 0
          type: integer
        modelId:
          description: The model ID.
          type: string
        numTopClasses:
          description: Number of top predicted classes for each row that will be explained
            for multiclass. Mutually exclusive with classNames. If neither specified
            - we assume numTopClasses=1.
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.29
        thresholdHigh:
          default: null
          description: The high threshold, above which a prediction must score in
            order for prediction explanations to be computed. If neither thresholdHigh
            nor thresholdLow is specified, prediction explanations will be computed
            for all rows.
          nullable: true
          type: number
        thresholdLow:
          default: null
          description: The lower threshold, below which a prediction must score in
            order for prediction explanations to be computed for a row in the dataset.
            If neither thresholdHigh nor thresholdLow is specified, prediction explanations
            will be computed for all rows.
          nullable: true
          type: number
      required:
      - datasetId
      - modelId
      type: object
    PredictionExplanationsInitializationCreate:
      properties:
        maxExplanations:
          default: 3
          description: The maximum number of prediction explanations to supply per
            row of the dataset.
          maximum: 10
          minimum: 1
          type: integer
        thresholdHigh:
          default: null
          description: The high threshold, above which a prediction must score in
            order for prediction explanations to be computed. If neither thresholdHigh
            nor thresholdLow is specified, prediction explanations will be computed
            for all rows.
          nullable: true
          type: number
        thresholdLow:
          default: null
          description: The lower threshold, below which a prediction must score in
            order for prediction explanations to be computed for a row in the dataset.
            If neither thresholdHigh nor thresholdLow is specified, prediction explanations
            will be computed for all rows.
          nullable: true
          type: number
      type: object
    PredictionExplanationsInitializationRetrieve:
      properties:
        modelId:
          description: The model ID.
          type: string
        predictionExplanationsSample:
          description: Each is a PredictionExplanationsRow. They represent a small
            sample of prediction explanations that could be generated for a particular
            dataset. They will have the same schema as the `data` array in the response
            from :http:get:`/api/v2/projects/(projectId)/predictionExplanations/(predictionExplanationsId)/`.
            As of v2.21 only difference is that there is no forecastPoint in response
            for time series projects.
          items:
            $ref: '#/components/schemas/PredictionExplanationsRow'
          type: array
        projectId:
          description: The project ID.
          type: string
      required:
      - modelId
      - predictionExplanationsSample
      - projectId
      type: object
    PredictionExplanationsMetadataValues:
      properties:
        shapRemainingTotal:
          description: Will be present only if `explanationAlgorithm` = 'shap' and
            `maxExplanations` is nonzero. The total of SHAP values for features beyond
            the `maxExplanations`. This can be identically 0 in all rows, if `maxExplanations`
            is greater than the number of features and thus all features are returned.
          type: integer
      type: object
    PredictionExplanationsObject:
      properties:
        feature:
          description: The name of the feature contributing to the prediction.
          type: string
        featureValue:
          description: The value the feature took on for this row. The type corresponds
            to the feature (bool, int, float, str, etc.).
          oneOf:
          - type: integer
          - type: boolean
          - type: string
          - type: number
        label:
          description: Describes what output was driven by this prediction explanation.
            For regression projects, it is the name of the target feature. For classification
            projects, it is the class whose probability increasing would correspond
            to a positive strength of this prediction explanation. For predictions
            made using anomaly detection models, it is the `Anomaly Score`.
          oneOf:
          - type: string
          - type: number
        strength:
          description: Algorithm-specific explanation value attributed to `feature`
            in this row. If `explanationAlgorithm` = `shap`, this is the SHAP value.
          nullable: true
          type: number
      required:
      - feature
      - featureValue
      - label
      type: object
    PredictionExplanationsPredictionValues:
      properties:
        label:
          description: Describes what this model output corresponds to. For regression
            projects, it is the name of the target feature. For classification projects,
            it is a level from the target feature. For Anomaly Detection models it
            is an Anomaly Score.
          type: string
        value:
          description: The output of the prediction. For regression projects, it is
            the predicted value of the target. For classification projects, it is
            the predicted probability the row belongs to the class identified by the
            label.
          type: number
      required:
      - label
      - value
      type: object
    PredictionExplanationsRecord:
      properties:
        datasetId:
          description: The dataset ID.
          type: string
        finishTime:
          description: Timestamp referencing when computation for these prediction
            explanations finished.
          type: number
        id:
          description: The PredictionExplanationsRecord ID.
          type: string
        maxExplanations:
          description: The maximum number of codes generated per prediction.
          type: integer
        modelId:
          description: The model ID.
          type: string
        numColumns:
          description: The number of columns prediction explanations were computed
            for.
          type: integer
        predictionExplanationsLocation:
          description: Where to retrieve the prediction explanations.
          type: string
        predictionThreshold:
          description: The threshold value used for binary classification prediction.
          nullable: true
          type: number
        projectId:
          description: The project ID.
          type: string
        thresholdHigh:
          description: The prediction explanation high threshold. Predictions must
            be above this value (or below the thresholdLow value) to have PredictionExplanations
            computed.
          nullable: true
          type: number
        thresholdLow:
          description: The prediction explanation low threshold. Predictions must
            be below this value (or above the thresholdHigh value) to have PredictionExplanations
            computed.
          nullable: true
          type: number
      required:
      - datasetId
      - finishTime
      - id
      - maxExplanations
      - modelId
      - numColumns
      - predictionExplanationsLocation
      - predictionThreshold
      - projectId
      - thresholdHigh
      - thresholdLow
      type: object
    PredictionExplanationsRecordList:
      properties:
        count:
          description: The number of items returned on this page.
          minimum: 0
          type: integer
        data:
          description: Each has the same schema as if retrieving the prediction explanations
            individually from :http:get:`/api/v2/projects/(projectId)/predictionExplanationsRecords/(predictionExplanationsId)/`.
          items:
            $ref: '#/components/schemas/PredictionExplanationsRecord'
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    PredictionExplanationsRetrieve:
      properties:
        adjustmentMethod:
          description: '''exposureNormalized'' (for regression projects with exposure)
            or ''N/A'' (for classification projects) The value of ''exposureNormalized''
            indicates that prediction outputs are adjusted (or divided) by exposure.
            The value of ''N/A'' indicates that no adjustments are applied to the
            adjusted predictions and they are identical to the unadjusted predictions.'
          type: string
          x-versionadded: v2.8
        count:
          description: How many rows of prediction explanations were returned.
          type: integer
        data:
          description: Each is a PredictionExplanationsRow corresponding to one row
            of the prediction dataset.
          items:
            $ref: '#/components/schemas/PredictionExplanationsRow'
          type: array
        id:
          description: The ID of this group of prediction explanations.
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        predictionExplanationsRecordLocation:
          description: The URL of the PredictionExplanationsRecord associated with
            these prediction explanations.
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - adjustmentMethod
      - count
      - data
      - id
      - next
      - predictionExplanationsRecordLocation
      - previous
      type: object
    PredictionExplanationsRow:
      properties:
        adjustedPrediction:
          description: The exposure-adjusted output of the model for this row.
          type: number
          x-versionadded: v2.8
        adjustedPredictionValues:
          description: The exposure-adjusted output of the model for this row.
          items:
            $ref: '#/components/schemas/PredictionExplanationsPredictionValues'
          type: array
          x-versionadded: v2.8
        forecastDistance:
          description: Forecast distance for the row. For time series projects only.
          type: integer
          x-versionadded: v2.21
        forecastPoint:
          description: Forecast point for the row. For time series projects only.
          type: string
          x-versionadded: v2.21
        prediction:
          description: The output of the model for this row.
          type: number
        predictionExplanations:
          description: A list of prediction explanations.
          items:
            $ref: '#/components/schemas/PredictionExplanation'
          type: array
        predictionThreshold:
          description: The threshold value used for classification prediction.
          nullable: true
          type: number
        predictionValues:
          description: A list of prediction values.
          items:
            $ref: '#/components/schemas/PredictionExplanationsPredictionValues'
          type: array
        rowId:
          description: Which row this PredictionExplanationsRow describes.
          type: integer
        seriesId:
          description: The ID of the series value for the row in a multiseries project.
            For a single series project this will be null. For time series projects
            only.
          nullable: true
          type: string
          x-versionadded: v2.21
        timestamp:
          description: Timestamp for the row. For time series projects only.
          type: string
          x-versionadded: v2.21
      required:
      - adjustedPrediction
      - adjustedPredictionValues
      - forecastDistance
      - forecastPoint
      - prediction
      - predictionExplanations
      - predictionThreshold
      - predictionValues
      - rowId
      - seriesId
      - timestamp
      type: object
    PredictionExportListResponse:
      properties:
        count:
          description: Number of paginated entries.
          minimum: 0
          type: integer
          x-versionadded: v2.33
        data:
          description: A list of prediction data exports.
          items:
            $ref: '#/components/schemas/ExportEntity'
          type: array
          x-versionadded: v2.33
        next:
          description: URL to the next page, or null if there is no such page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL to the previous page, or null if there is no such page
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: Total number of entries.
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    PredictionFileUpload:
      properties:
        actualValueColumn:
          description: 'Actual value column name, valid for the prediction files if
            the project is unsupervised and the dataset is considered as bulk predictions
            dataset. '
          type: string
          x-versionadded: v2.21
        credentials:
          description: A list of credentials for the secondary datasets used in feature
            discovery project
          type: string
          x-versionadded: v2.19
        file:
          description: The dataset file to upload for prediction.
          format: binary
          type: string
        forecastPoint:
          description: For time series projects only. The time in the dataset relative
            to which predictions are generated. If not specified the default value
            is the value in the row with the latest specified timestamp. Specifying
            this value for a project that is not a time series project will result
            in an error.
          format: date-time
          type: string
          x-versionadded: v2.8
        predictionsEndDate:
          description: Used for time series projects only. The end date for bulk predictions.
            Note that this parameter is used for generating historical predictions
            using the training data, not for future predictions. If not specified,
            the dataset is not considered as a bulk predictions dataset. This parameter
            should be provided in conjunction with a ``predictionsStartDate``, and
            cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        predictionsStartDate:
          description: Used for time series projects only. The start date for bulk
            predictions. Note that this parameter is used for generating historical
            predictions using the training data, not for future predictions. If not
            specified, the dataset is not considered as a bulk predictions dataset.
            This parameter should be provided in conjunction with a ``predictionsEndDate``,
            and cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          description: A boolean flag. If true, missing values in the known in advance
            features are allowed in the forecast window at the prediction time. If
            omitted or false, missing values are not allowed. For time series projects
            only.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
          x-versionadded: v2.15
        secondaryDatasetsConfigId:
          description: Optional, for feature discovery projects only. The Id of the
            alternative secondary dataset config to use during prediction.
          type: string
          x-versionadded: v2.19
      required:
      - file
      type: object
    PredictionFromCatalogDataset:
      properties:
        actualValueColumn:
          description: Actual value column name, valid for the prediction files if
            the project is unsupervised and the dataset is considered as bulk predictions
            dataset.
          type: string
          x-versionadded: v2.21
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentials'
          - $ref: '#/components/schemas/GoogleServiceAccountCredentials'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentials'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentials'
          x-versionadded: v2.23
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
          type: string
          x-versionadded: v2.19
        credentials:
          description: List of credentials for the secondary datasets used in feature
            discovery project.
          items:
            oneOf:
            - $ref: '#/components/schemas/PasswordCredentials'
            - $ref: '#/components/schemas/CredentialId'
          maxItems: 30
          type: array
          x-versionadded: v2.19
        datasetId:
          description: The ID of the dataset entry to use for prediction dataset.
          type: string
        datasetVersionId:
          description: The ID of the dataset version to use for the prediction dataset.
            If not specified - uses latest version associated with datasetId.
          type: string
        forecastPoint:
          description: For time series projects only. The time in the dataset relative
            to which predictions are generated. This value is optional. If not specified
            the default value is the value in the row with the latest specified timestamp.
            Specifying this value for a project that is not a time series project
            will result in an error.
          format: date-time
          type: string
          x-versionadded: v2.8
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server side in scope of HTTP request
            and never saved or stored.DEPRECATED: please use credentialId or credentialData
            instead.'
          type: string
          x-versiondeprecated: v2.23
        predictionsEndDate:
          description: The end date for bulk predictions, exclusive. Used for time
            series projects only. Note that this parameter is used for generating
            historical predictions using the training data, not for future predictions.
            If not specified, the dataset is not considered as a bulk predictions
            dataset. This parameter should be provided in conjunction with a ``predictionsStartDate``,
            and cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        predictionsStartDate:
          description: The start date for bulk predictions. Used for time series projects
            only. Note that this parameter is used for generating historical predictions
            using the training data, not for future predictions. If not specified,
            the dataset is not considered as a bulk predictions dataset. This parameter
            should be provided in conjunction with a ``predictionsEndDate``, and cannot
            be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          description: For time series projects only. If True, missing values in the
            known in advance features are allowed in the forecast window at the prediction
            time. If omitted or False, missing values are not allowed.
          type: boolean
        secondaryDatasetsConfigId:
          description: For feature discovery projects only. The Id of the alternative
            secondary dataset config to use during prediction.
          type: string
          x-versionadded: v2.19
        useKerberos:
          default: false
          description: If true, use kerberos authentication for database authentication.
            Default is false.
          type: boolean
          x-versionadded: v2.19
        user:
          description: 'The username for database authentication. DEPRECATED: please
            use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
      required:
      - datasetId
      type: object
    PredictionIntervals:
      properties:
        enabled:
          description: 'Indicates whether prediction intervals are enabled for this
            deployment. '
          type: boolean
        percentiles:
          description: The percentiles used for this deployment. Currently, we support
            at most one percentile at a time.
          items:
            type: integer
          type: array
      required:
      - enabled
      type: object
    PredictionIntervalsCreate:
      properties:
        percentiles:
          description: The list of prediction intervals percentiles to calculate.
            Currently we only allow requesting one interval at a time.
          items:
            exclusiveMinimum: true
            maximum: 100
            minimum: 0
            type: integer
          maxItems: 1
          minItems: 1
          type: array
      required:
      - percentiles
      type: object
    PredictionIntervalsCreateResponse:
      properties:
        message:
          description: Any extended message to include about the result. For example,
            if a job is submitted that is a duplicate of a job that has already been
            added to the queue, the message will mention that no new job was created.
          type: string
      required:
      - message
      type: object
    PredictionIntervalsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A descending-ordered array of already-calculated prediction
            intervals percentiles.
          items:
            exclusiveMinimum: true
            maximum: 100
            minimum: 0
            type: integer
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    PredictionIntervalsUpdate:
      properties:
        enabled:
          description: True if prediction intervals are enabled for this deployment,
            false if otherwise
          type: boolean
        percentiles:
          description: if prediction intervals are enabled, the percentiles to use
            for this deployment. Currently, we support at most one percentile at a
            time.
          items:
            type: integer
          type: array
      required:
      - enabled
      type: object
    PredictionObject:
      properties:
        actualValue:
          description: In the case of an unsupervised time series project with a dataset
            using ``predictionsStartDate`` and ``predictionsEndDate`` for bulk predictions
            and a specified actual value column, the predictions will be a json array
            in the same format as with a forecast point with one additional element
            - `actualValues`. It is the actual value in the row.
          nullable: true
          type: string
          x-versionadded: v2.21
        forecastDistance:
          description: (if time series project) The number of time units this prediction
            is away from the forecastPoint. The unit of time is determined by the
            timeUnit of the datetime partition column.
          nullable: true
          type: integer
        forecastPoint:
          description: (if time series project) The forecastPoint of the predictions.
            Either provided or inferred.
          format: date-time
          nullable: true
          type: string
        originalFormatTimestamp:
          description: The timestamp of this row in the prediction dataset. Unlike
            the ``timestamp`` field, this field will keep the same DateTime formatting
            as the uploaded prediction dataset. (This column is shown if enabled by
            your administrator.)
          type: string
          x-versionadded: v2.17
        positiveProbability:
          description: For binary classification, the probability the row belongs
            to the positive class.
          minimum: 0
          nullable: true
          type: number
        prediction:
          description: The prediction of the model.
          oneOf:
          - description: If using a regressor model, will be the numeric value of
              the target.
            type: number
          - description: If using a binary or muliclass classifier model, will be
              the predicted class.
            type: string
          - description: If using a multilabel classifier model, will be a list of
              predicted classes.
            items:
              type: string
            type: array
        predictionExplanationMetadata:
          description: Array containing algorithm-specific values. Varies depending
            on the value of `explanationAlgorithm`.
          items:
            $ref: '#/components/schemas/PredictionExplanationsMetadataValues'
            description: Prediction explanation metadata.
          type: array
          x-versionadded: v2.21
        predictionExplanations:
          description: Array contains `predictionExplanation` objects. The total elements
            in the array are bounded by maxExplanations and feature count. It will
            be present only if `explanationAlgorithm` is not null (prediction explanations
            were requested).
          items:
            $ref: '#/components/schemas/PredictionExplanationsObject'
            description: Prediction explanation result.
          nullable: true
          type: array
          x-versionadded: v2.21
        predictionIntervalLowerBound:
          description: Present if ``includePredictionIntervals`` is True. Indicates
            a lower bound of the estimate of error based on test data.
          type: number
          x-versionadded: v2.16
        predictionIntervalUpperBound:
          description: Present if ``includePredictionIntervals`` is True. Indicates
            an upper bound of the estimate of error based on test data.
          type: number
          x-versionadded: v2.16
        predictionThreshold:
          description: Threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
        predictionValues:
          description: A list of predicted values for this row.
          items:
            $ref: '#/components/schemas/PredictionArrayObjectValues'
            description: Predicted values
          type: array
        rowId:
          description: The row in the prediction dataset this prediction corresponds
            to.
          minimum: 0
          type: integer
        segmentId:
          description: The ID of the segment value for a segmented project.
          type: string
          x-versionadded: v2.27
        seriesId:
          description: The ID of the series value for a multiseries project. For time
            series projects that are not a multiseries this will be a NaN.
          nullable: true
          type: string
        target:
          description: In the case of a time series project with a dataset using predictionsStartDate
            and predictionsEndDate for bulk predictions, the predictions will be a
            json array in the same format as with a forecast point with one additional
            element - `target`. It is the target value in the row.
          nullable: true
          type: string
        timestamp:
          description: (if time series project) The timestamp of this row in the prediction
            dataset.
          format: date-time
          nullable: true
          type: string
      required:
      - prediction
      - rowId
      type: object
    PredictionRemoteEventData:
      properties:
        error_code:
          description: The error code if any.
          nullable: true
          type: string
        model_id:
          description: The identifier of the model.
          nullable: true
          type: string
        response_body:
          description: The response body message of the prediction event.
          type: string
        status_code:
          description: The response status code of the prediction event.
          type: integer
        user_id:
          description: The identifier of the user that accesses the deployment.
          nullable: true
          type: string
      required:
      - response_body
      - status_code
      type: object
    PredictionResultResponse:
      properties:
        actual:
          description: Actual value of the prediction
          oneOf:
          - type: integer
          - type: number
          - type: string
        associationId:
          description: Association id of the prediction, which is used to associate
            a prediction with its actual value and calculate accuracy.
          type: string
        forecastDistance:
          description: The number of time units this prediction is away from the forecastPoint.
            The unit of time is determined by the timeUnit of the datetime partition
            column. For time series models only.
          nullable: true
          type: integer
          x-versionadded: v2.23
        modelId:
          description: ID of the model used to make these predictions
          type: string
        predicted:
          description: Predicted value of the prediction
          oneOf:
          - type: integer
          - type: number
          - type: string
        timestamp:
          description: When the prediction was made.
          format: date-time
          type: string
      required:
      - actual
      - associationId
      - modelId
      - predicted
      - timestamp
      type: object
    PredictionResultsListResponse:
      properties:
        associationIdColumnNames:
          description: List of column names used to represent an association id, which
            is used to unique identify individual prediction rows.
          items:
            type: string
          nullable: true
          type: array
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of prediction requests.
          items:
            $ref: '#/components/schemas/PredictionResultResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - associationIdColumnNames
      - data
      - next
      - previous
      type: object
    PredictionRetrieveResponse:
      properties:
        actualValueColumn:
          description: For time series unsupervised projects only. Will be present
            only if the prediction dataset has an actual value column. The name of
            the column with actuals that was used to calculate the scores and insights.
          nullable: true
          type: string
          x-versionadded: v2.21
        explanationAlgorithm:
          description: The selected algorithm to use for prediction explanations.
            At present, the only acceptable value is 'shap', which selects the SHapley
            Additive exPlanations (SHAP) explainer. Defaults to null (no prediction
            explanations).
          nullable: true
          type: string
          x-versionadded: v2.21
        featureDerivationWindowCounts:
          description: For time series projects with partial history only. Indicates
            how many points were used during feature derivation in feature derivation
            window.
          nullable: true
          type: integer
          x-versionadded: v2.24
        includesPredictionIntervals:
          description: For time series projects only. Indicates if prediction intervals
            will be part of the response. Defaults to False.
          type: boolean
          x-versionadded: v2.16
        maxExplanations:
          description: The maximum number of prediction explanations values to be
            returned with each row in the `predictions` json array. Null indicates
            'no limit'. Will be present only if `explanationAlgorithm` was set.
          nullable: true
          type: integer
          x-versionadded: v2.21
        positiveClass:
          description: For binary classification, the class of the target deemed the
            positive class. For all other project types this field will be null.
          nullable: true
          oneOf:
          - type: string
          - type: integer
          - type: number
        predictionIntervalsSize:
          description: For time series projects only. Will be present only if `includePredictionIntervals`
            is True. Indicates the percentile used for prediction intervals calculation.
            Defaults to 80.
          nullable: true
          type: integer
          x-versionadded: v2.16
        predictions:
          description: The json array of predictions. The predictions in the response
            will have slightly different formats, depending on the project type.
          items:
            $ref: '#/components/schemas/PredictionObject'
          type: array
        shapBaseValue:
          description: Will be present only if `explanationAlgorithm` = 'shap'. The
            model's average prediction over the training data. SHAP values are deviations
            from the base value.
          nullable: true
          type: number
          x-versionadded: v2.21
        shapWarnings:
          description: Will be present if `explanationAlgorithm` was set to `shap`
            and there were additivity failures during SHAP values calculation.
          items:
            $ref: '#/components/schemas/ShapWarningValues'
            description: Mismatch information
          nullable: true
          type: array
          x-versionadded: v2.21
        task:
          description: The prediction task.
          enum:
          - Regression
          - Binary
          - Multiclass
          - Multilabel
          type: string
      required:
      - positiveClass
      - predictions
      - task
      type: object
    PredictionServerListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of prediction servers.
          items:
            $ref: '#/components/schemas/PredictionServerResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    PredictionServerResponse:
      properties:
        batchPredictions:
          $ref: '#/components/schemas/BatchPredictionStatus'
          description: Batch Prediction status for this instance
          x-versionadded: v2.28
        datarobot-key:
          description: The `datarobot-key` header used in requests to this prediction
            server.
          nullable: true
          type: string
        id:
          description: ID of the prediction server.
          nullable: true
          type: string
        url:
          description: URL of the prediction server.
          type: string
      required:
      - batchPredictions
      - datarobot-key
      - id
      - url
      type: object
    PredictionURLUpload:
      properties:
        actualValueColumn:
          description: Actual value column name, valid for the prediction files if
            the project is unsupervised and the dataset is considered as bulk predictions
            dataset. This value is optional.
          type: string
          x-versionadded: v2.21
        credentials:
          description: A list of credentials for the secondary datasets used in feature
            discovery project
          items:
            oneOf:
            - $ref: '#/components/schemas/PasswordCredentials'
            - $ref: '#/components/schemas/CredentialId'
          maxItems: 30
          type: array
          x-versionadded: v2.19
        forecastPoint:
          description: For time series projects only. The time in the dataset relative
            to which predictions are generated. If not specified the default value
            is the value in the row with the latest specified timestamp. Specifying
            this value for a project that is not a time series project will result
            in an error.
          format: date-time
          type: string
          x-versionadded: v2.8
        predictionsEndDate:
          description: Used for time series projects only. The end date for bulk predictions,
            exclusive. Note that this parameter is used for generating historical
            predictions using the training data, not for future predictions. If not
            specified, the dataset is not considered as a bulk predictions dataset.
            This parameter should be provided in conjunction with a ``predictionsStartDate``,
            and cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        predictionsStartDate:
          description: Used for time series projects only. The start date for bulk
            predictions. Note that this parameter is used for generating historical
            predictions using the training data, not for future predictions. If not
            specified, the dataset is not considered as a bulk predictions dataset.
            This parameter should be provided in conjunction with a ``predictionsEndDate``,
            and cannot be provided with the ``forecastPoint`` parameter.
          format: date-time
          type: string
        relaxKnownInAdvanceFeaturesCheck:
          description: For time series projects only. If true, missing values in the
            known in advance features are allowed in the forecast window at the prediction
            time. This value is optional. If omitted or false, missing values are
            not allowed.
          type: boolean
          x-versionadded: v2.15
        secondaryDatasetsConfigId:
          description: For feature discovery projects only. The ID of the alternative
            secondary dataset config to use during prediction.
          type: string
          x-versionadded: v2.19
        url:
          description: The URL to download the dataset from.
          format: url
          type: string
      required:
      - url
      type: object
    PredictionUsageObjectResponse:
      properties:
        avgExecutionTime:
          description: The average predictions execution time during `timestamp` hour
          type: number
        blenderModelTypes:
          description: The type of blender model.
          nullable: true
          type: string
        datasetId:
          description: The id of the dataset.
          type: string
        deploymentId:
          description: The id of the deployment.
          nullable: true
          type: string
        deploymentType:
          description: The type of deployment
          nullable: true
          type: string
        groupId:
          description: The id of the group.
          nullable: true
          type: string
        groupName:
          description: The name of the group.
          nullable: true
          type: string
        modelId:
          description: The id of the model.
          nullable: true
          type: string
        modelType:
          description: The type of the model.
          nullable: true
          type: string
        orgId:
          description: The id of the organization.
          nullable: true
          type: string
        orgName:
          description: The name of the organization.
          nullable: true
          type: string
        predictionExplanations:
          description: If it contains prediction explanations.
          nullable: true
          type: boolean
        predictionMethod:
          description: The prediction method that was used.
          type: string
        predictionRowCountPerMinute:
          description: List of row counts per minute.
          items:
            type: integer
          nullable: true
          type: array
        predictionRowsCount:
          description: Predictions rows count during `timestamp` hour.
          type: integer
        projectId:
          description: The id of the project.
          nullable: true
          type: string
        projectType:
          description: The type of the project.
          nullable: true
          type: string
        pythonVersion:
          description: The python version used to build models in the project
          nullable: true
          type: string
        recommendedModel:
          description: If it is a recommended model.
          nullable: true
          type: boolean
        requestCountPerMinute:
          description: List of requests per minute.
          items:
            type: integer
          nullable: true
          type: array
        requestsCount:
          description: Request count during `timestamp` hour.
          type: integer
        serverErrorCount:
          description: Server error count during `timestamp` hour.
          type: integer
        timestamp:
          description: The timestamp of the event.
          format: date-time
          type: string
        userErrorCount:
          description: User error count during `timestamp` hour.
          type: integer
        userId:
          description: The id of the user.
          type: string
        userProjectRole:
          description: The role of the user to the related project.
          nullable: true
          type: string
        username:
          description: The username of the user. Will be empty if ``includeIdentifyingFields``
            is True.
          nullable: true
          type: string
      required:
      - avgExecutionTime
      - predictionExplanations
      - predictionMethod
      - predictionRowsCount
      - requestsCount
      - serverErrorCount
      - timestamp
      - userErrorCount
      - userId
      type: object
    PredictionUsageRetrieveResponse:
      properties:
        count:
          description: Amount of returned items
          type: integer
        data:
          description: A json array of prediction usage rows described below
          items:
            $ref: '#/components/schemas/PredictionUsageObjectResponse'
          type: array
        next:
          description: A URL to the next page (if null, no next page exists).
          format: uri
          nullable: true
          type: string
        previous:
          description: A URL to the previous page (if null, no previous page exists).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: Amount of items matching the query condition
          type: integer
          x-versionadded: v2.23
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    PredictionWarning:
      properties:
        customBoundaries:
          $ref: '#/components/schemas/CustomBoundaries'
          description: Null if default boundaries for the model are used
          nullable: true
        enabled:
          description: Indicates whether prediction warnings are enabled for this
            deployment.
          type: boolean
      required:
      - customBoundaries
      - enabled
      type: object
    PredictionWarningUpdate:
      properties:
        customBoundaries:
          $ref: '#/components/schemas/CustomBoundaries'
          description: If omitted, boundaries will not be changed. Null if default
            boundaries for the model should be used.
          nullable: true
        enabled:
          description: True if prediction warnings are enabled for this deployment,
            false otherwise.
          type: boolean
      required:
      - enabled
      type: object
    PredictionsDataCollection:
      properties:
        enabled:
          description: Indicates whether incoming prediction requests and results
            should be stored in record-level storage.
          type: boolean
      required:
      - enabled
      type: object
    PredictionsOverBatchBucket:
      properties:
        batch:
          $ref: '#/components/schemas/DriftBatch'
          description: Info of the batch associated with the bucket.
          x-versionadded: v2.33
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          nullable: true
          type: array
          x-versionadded: v2.33
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
          x-versionadded: v2.33
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          nullable: true
          type: array
          x-versionadded: v2.33
        percentiles:
          description: Predicted value or positive class predicted probability at
            specific percentiles in the bucket, only for regression and binary classification
            deployments.
          items:
            $ref: '#/components/schemas/Percentile'
          nullable: true
          type: array
          x-versionadded: v2.33
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          nullable: true
          type: integer
          x-versionadded: v2.33
        rowCount:
          description: Number of rows in the bucket.
          nullable: true
          type: integer
          x-versionadded: v2.33
      required:
      - batch
      - rowCount
      type: object
    PredictionsOverBatchResponse:
      properties:
        baselines:
          description: Target baselines
          items:
            $ref: '#/components/schemas/TargetBaseline'
          type: array
          x-versionadded: v2.33
        buckets:
          description: Predictions over batch buckets
          items:
            $ref: '#/components/schemas/PredictionsOverBatchBucket'
          type: array
          x-versionadded: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - baselines
      - buckets
      type: object
    PredictionsOverTimeBucket:
      properties:
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          nullable: true
          type: array
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          nullable: true
          type: array
        modelId:
          description: ID of the model
          type: string
        percentiles:
          description: Predicted value or positive class predicted probability at
            specific percentiles in the bucket, only for regression and binary classification
            deployments.
          items:
            $ref: '#/components/schemas/Percentile'
          nullable: true
          type: array
        period:
          $ref: '#/components/schemas/TimeRange'
          description: Info of the time period associated with the bucket.
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          nullable: true
          type: integer
        rowCount:
          description: Number of rows in the bucket.
          nullable: true
          type: integer
      required:
      - modelId
      - period
      - rowCount
      type: object
    PredictionsOverTimeResponse:
      properties:
        baselines:
          description: Target baselines
          items:
            $ref: '#/components/schemas/TargetBaseline'
          type: array
        buckets:
          description: Predictions over time buckets
          items:
            $ref: '#/components/schemas/PredictionsOverTimeBucket'
          type: array
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - baselines
      - buckets
      type: object
    PredictionsVsActualsBaseline:
      properties:
        actualClassDistribution:
          description: Class distribution for all actuals in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ActualClassDistribution'
          nullable: true
          type: array
        meanActualValue:
          description: Mean actual value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
        modelId:
          description: ID of the model.
          type: string
        predictedClassDistribution:
          description: Class distribution for all rows with actual in the bucket,
            only for classification deployments.
          items:
            $ref: '#/components/schemas/PredictedClassDistribution'
          nullable: true
          type: array
        rowCountTotal:
          description: Number of rows in the bucket.
          type: integer
        rowCountWithActual:
          description: Number of rows with actual in the bucket.
          type: integer
      required:
      - modelId
      - rowCountTotal
      - rowCountWithActual
      type: object
    PredictionsVsActualsBatchBucket:
      properties:
        actualClassDistribution:
          description: Class distribution for all actuals in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ActualClassDistribution'
          nullable: true
          type: array
          x-versionadded: v2.33
        batchId:
          description: ID of the batch.
          type: string
          x-versionadded: v2.33
        batchName:
          description: Name of the batch.
          type: string
          x-versionadded: v2.33
        meanActualValue:
          description: Mean actual value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
          x-versionadded: v2.33
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
          x-versionadded: v2.33
        modelId:
          description: ID of the model.
          type: string
          x-versionadded: v2.33
        period:
          $ref: '#/components/schemas/BatchPeriod'
          description: Time period of the batch.
          x-versionadded: v2.33
        predictedClassDistribution:
          description: Class distribution for all rows with actual in the bucket,
            only for classification deployments.
          items:
            $ref: '#/components/schemas/PredictedClassDistribution'
          nullable: true
          type: array
          x-versionadded: v2.33
        rowCountTotal:
          description: Number of rows in the bucket.
          type: integer
          x-versionadded: v2.33
        rowCountWithActual:
          description: Number of rows with actual in the bucket.
          type: integer
          x-versionadded: v2.33
      required:
      - batchId
      - batchName
      - modelId
      - period
      - rowCountTotal
      - rowCountWithActual
      type: object
    PredictionsVsActualsOverBatchResponse:
      properties:
        baselines:
          description: Predictions vs actuals baselines.
          items:
            $ref: '#/components/schemas/PredictionsVsActualsBaseline'
          type: array
          x-versionadded: v2.33
        buckets:
          description: Predictions vs actuals buckets.
          items:
            $ref: '#/components/schemas/PredictionsVsActualsBatchBucket'
          type: array
          x-versionadded: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - baselines
      - buckets
      type: object
    PredictionsVsActualsOverTimeResponse:
      properties:
        baselines:
          description: Predictions vs actuals baselines.
          items:
            $ref: '#/components/schemas/PredictionsVsActualsBaseline'
          type: array
        buckets:
          description: Predictions vs actuals buckets.
          items:
            $ref: '#/components/schemas/PredictionsVsActualsTimeBucket'
          type: array
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/PredictionsVsActualsSummaryBucket'
          description: Predictions vs actuals summary.
      required:
      - baselines
      - buckets
      - summary
      type: object
    PredictionsVsActualsSummaryBucket:
      properties:
        rowCountTotal:
          description: Number of rows for all buckets.
          type: integer
        rowCountWithActual:
          description: Number of rows with actual for all buckets.
          type: integer
      required:
      - rowCountTotal
      - rowCountWithActual
      type: object
    PredictionsVsActualsTimeBucket:
      properties:
        actualClassDistribution:
          description: Class distribution for all actuals in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ActualClassDistribution'
          nullable: true
          type: array
        meanActualValue:
          description: Mean actual value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
        modelId:
          description: ID of the model.
          type: string
        period:
          $ref: '#/components/schemas/BatchPeriod'
          description: Time period of the bucket.
        predictedClassDistribution:
          description: Class distribution for all rows with actual in the bucket,
            only for classification deployments.
          items:
            $ref: '#/components/schemas/PredictedClassDistribution'
          nullable: true
          type: array
        rowCountTotal:
          description: Number of rows in the bucket.
          type: integer
        rowCountWithActual:
          description: Number of rows with actual in the bucket.
          type: integer
      required:
      - modelId
      - period
      - rowCountTotal
      - rowCountWithActual
      type: object
    PreloadedCalendar:
      properties:
        countryCode:
          description: Code of the country for which holidays should be generated.
            Code needs to be uppercase and should belong to the list of countries
            which can be retrieved via :http:get:`/api/v2/calendarCountryCodes/`
          enum:
          - AR
          - AT
          - AU
          - AW
          - BE
          - BG
          - BR
          - BY
          - CA
          - CH
          - CL
          - CO
          - CZ
          - DE
          - DK
          - DO
          - EE
          - ES
          - FI
          - FRA
          - GB
          - HK
          - HND
          - HR
          - HU
          - IE
          - IND
          - IS
          - IT
          - JP
          - KE
          - LT
          - LU
          - MX
          - NG
          - NI
          - NL
          - 'NO'
          - NZ
          - PE
          - PL
          - PT
          - PTE
          - RU
          - SE
          - SE(NS)
          - SI
          - SK
          - TAR
          - UA
          - UK
          - US
          - ZA
          type: string
        endDate:
          description: Last date of the range of dates for which holidays are generated.
          format: date-time
          type: string
        startDate:
          description: First date of the range of dates for which holidays are generated.
          format: date-time
          type: string
      required:
      - countryCode
      - endDate
      - startDate
      type: object
    PreloadedCalendarCountryCodeRecord:
      properties:
        code:
          description: Country code that can be used for calendars generation.
          type: string
        name:
          description: Full name of the country.
          type: string
      required:
      - code
      - name
      type: object
    PreloadedCalendarListResponse:
      properties:
        count:
          description: The number of items returned on this page considering offset
            and limit values.
          minimum: 0
          type: integer
        data:
          description: An array of dictionaries which contain country code and full
            name of the countries corresponding to codes.
          items:
            $ref: '#/components/schemas/PreloadedCalendarCountryCodeRecord'
            description: Each item has the country code and the full name of the corresponding
              country
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    PrepareForDeployment:
      properties:
        modelId:
          description: The model to prepare for deployment.
          type: string
      required:
      - modelId
      type: object
    PresentationApplicationCreate:
      properties:
        authenticationType:
          default: invitedUsersOnly
          description: Authentication type
          enum:
          - invitedUsersOnly
          - token
          nullable: true
          type: string
        description:
          description: The description of the application
          maxLength: 512
          nullable: true
          type: string
        experimentContainerId:
          description: '[DEPRECATED - replaced with use_case_id] The ID of the experiment
            container associated with the application.'
          type: string
        modelId:
          description: The ID of the model associated with the application.
          type: string
        name:
          description: The name of the app
          maxLength: 512
          minLength: 1
          type: string
        projectId:
          description: The ID of the project associated with the application.
          type: string
        useCaseId:
          description: The ID of the Use Case associated with the application.
          type: string
      required:
      - modelId
      - projectId
      type: object
    PreviewPermadeleteStatus:
      properties:
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        reportId:
          description: Report ID
          type: string
        status:
          description: The processing state of report building task.
          enum:
          - ABORTED
          - BLOCKED
          - COMPLETED
          - CREATED
          - ERROR
          - EXPIRED
          - INCOMPLETE
          - INITIALIZED
          - PAUSED
          - RUNNING
          type: string
      required:
      - message
      - reportId
      - status
      type: object
    PrimeFileCreate:
      properties:
        language:
          description: The desired language of the generated code
          enum:
          - Python
          - Java
          type: string
        modelId:
          description: the Prime model to generate code for
          type: string
      required:
      - language
      - modelId
      type: object
    PrimeFileListResponse:
      properties:
        count:
          description: number of items returned on this page
          type: integer
        data:
          description: each has the same schema as if retrieving the file individually
            from GET /api/v2/projects/(projectId)/primeFiles/(primeFileId)/.
          items:
            $ref: '#/components/schemas/PrimeFileResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    PrimeFileResponse:
      properties:
        id:
          description: the ID of the file
          type: string
        isValid:
          description: whether the code passed basic validation checks
          type: boolean
        language:
          description: the language the code is written in (e.g. Python
          enum:
          - Python
          - Java
          type: string
        modelId:
          description: the Id of the Prime model
          type: string
        parentModelId:
          description: the ID of the model this code approximates
          type: string
        projectId:
          description: the ID of the project the file belongs to
          type: string
        rulesetId:
          description: the ID of the ruleset this code uses to approximate the parent
            model
          type: integer
      required:
      - id
      - isValid
      - language
      - modelId
      - parentModelId
      - projectId
      - rulesetId
      type: object
    PrimeInfoRetrieveResponse:
      properties:
        canMakePrime:
          description: Indicating whether the requested model is a valid input for
            creating a Prime mode
          type: boolean
        message:
          description: May contain details about why a model is not eligible for DataRobotPrime
          type: string
        messageId:
          description: An error code representing the reason the model cannot be approximated
            with DataRobot Prime; 0 for eligible models
          type: integer
      required:
      - canMakePrime
      - message
      - messageId
      type: object
    PrimeModelCreatePayload:
      properties:
        parentModelId:
          description: the model being approximated
          type: string
        rulesetId:
          description: the ID of the ruleset to use
          type: integer
      required:
      - parentModelId
      - rulesetId
      type: object
    PrimeModelDetailsRetrieveResponse:
      properties:
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
        dataSelectionMethod:
          description: Identifies which setting defines the training size of the model
            when making predictions and scoring. Only used by datetime models.
          enum:
          - duration
          - rowCount
          - selectedDateRange
          - useProjectSettings
          type: string
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        id:
          description: the ID of the model
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
        isNClustersDynamicallyDetermined:
          description: Whether number of clusters is dynamically determined. Only
            valid in unsupervised clustering projects.
          type: boolean
        isStarred:
          description: whether the model has been starred
          type: boolean
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          description: Object returning model lifecycle.
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          nullable: true
          type: string
          x-versionadded: v2.21
        metrics:
          description: the performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or null if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
        modelFamily:
          description: the family model belongs to, e.g. SVM, GBM, etc.
          type: string
          x-versionadded: v2.21
        modelFamilyFullName:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.31
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
        monotonicDecreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        monotonicIncreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          nullable: true
          type: integer
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
        predictionThreshold:
          description: threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.13
        predictionThresholdReadOnly:
          description: indicates whether modification of a predictions threshold is
            forbidden. Since v2.22 threshold modification is allowed.
          type: boolean
          x-versionadded: v2.13
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
        projectId:
          description: the ID of the project to which the model belongs
          type: string
        ruleCount:
          description: the number of rules used to create this model
          type: integer
        rulesetId:
          description: the ID of the ruleset this model uses
          type: integer
        samplePct:
          description: the percentage of the dataset used in training the model
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: number
        samplingMethod:
          description: indicates sampling method used to select training data in datetime
            models. For row-based project this is the way how requested number of
            rows are selected.For other projects (duration-based, start/end, project
            settings) - how specified percent of rows (timeWindowSamplePct) is selected
            from specified time window.
          enum:
          - random
          - latest
          type: string
        score:
          description: the validation score of the models ruleset
          type: number
        supportsComposableMl:
          description: indicates whether this model is supported in Composable ML.
          type: boolean
          x-versionadded: '2.26'
        supportsMonotonicConstraints:
          description: whether this model supports enforcing monotonic constraints
          type: boolean
          x-versionadded: v2.21
        timeWindowSamplePct:
          description: An integer between 1 and 99, indicating the percentage of sampling
            within the time window. The points kept are determined by samplingMethod
            option. Will be null if no sampling was specified. Only used by datetime
            models.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          nullable: true
          type: string
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          nullable: true
          type: string
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          nullable: true
          type: string
      required:
      - blueprintId
      - featurelistId
      - featurelistName
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - lifecycle
      - linkFunction
      - metrics
      - modelCategory
      - modelFamily
      - modelFamilyFullName
      - modelNumber
      - modelType
      - monotonicDecreasingFeaturelistId
      - monotonicIncreasingFeaturelistId
      - parentModelId
      - predictionThreshold
      - predictionThresholdReadOnly
      - processes
      - projectId
      - ruleCount
      - rulesetId
      - samplePct
      - score
      - supportsComposableMl
      - supportsMonotonicConstraints
      - trainingDuration
      - trainingEndDate
      - trainingRowCount
      - trainingStartDate
      type: object
    PrimeModelListResponse:
      properties:
        count:
          description: number of items returned on this page
          type: integer
        data:
          description: each has the same schema as if retrieving the file individually
            from GET /api/v2/projects/(projectId)/primeFiles/(primeFileId)/.
          items:
            $ref: '#/components/schemas/PrimeModelDetailsRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    PrimeRulesetsCreatePayload:
      type: object
    PrimeRulesetsListResponse:
      properties:
        modelId:
          description: the ID of the Prime model using this ruleset (if it exists)
            or null
          type: string
        parentModelId:
          description: ID of the model this ruleset approximates
          type: string
        projectId:
          description: the project this ruleset belongs to
          type: string
        ruleCount:
          description: the number of rules used by this ruleset
          type: integer
        rulesetId:
          description: the ID of the ruleset
          type: integer
        score:
          description: the validation score of the ruleset
          type: number
      required:
      - modelId
      - parentModelId
      - projectId
      - ruleCount
      - rulesetId
      - score
      type: object
    ProcessingLimits:
      properties:
        interval:
          description: A time interval that is applied when calculating processing
            limits.
          enum:
          - hour
          - day
          - week
          type: string
      required:
      - interval
      type: object
    ProjectAdvancedOptionsResponse:
      properties:
        allowedPairwiseInteractionGroups:
          description: For GAM models - specify groups of columns for which pairwise
            interactions will be allowed. E.g. if set to [["A", "B", "C"], ["C", "D"]]
            then GAM models will allow interactions between columns AxB, BxC, AxC,
            CxD. All others (AxD, BxD) will not be considered. If not specified -
            all possible interactions will be considered by model.
          items:
            items:
              type: string
            type: array
          type: array
          x-versionadded: v2.19
        blendBestModels:
          description: blend best models during Autopilot run [DEPRECATED]
          type: boolean
          x-versionadded: v2.19
          x-versiondeprecated: 2.30.0
        blueprintThreshold:
          description: an upper bound on running time (in hours), such that models
            exceeding the bound will be excluded in subsequent autopilot runs
          nullable: true
          type: integer
        considerBlendersInRecommendation:
          description: Include blenders when selecting a model to prepare for deployment
            in an Autopilot Run.[DEPRECATED]
          type: boolean
          x-versionadded: v2.21
          x-versiondeprecated: 2.30.0
        defaultMonotonicDecreasingFeaturelistId:
          description: null or str, the ID of the featurelist specifying a set of
            features with a monotonically decreasing relationship to the target. All
            blueprints generated in the project use this as their default monotonic
            constraint, but it can be overriden at model submission time.
          nullable: true
          type: string
          x-versionadded: v2.11
        defaultMonotonicIncreasingFeaturelistId:
          description: null or str, the ID of the featurelist specifying a set of
            features with a monotonically increasing relationship to the target. All
            blueprints generated in the project use this as their default monotonic
            constraint, but it can be overriden at model submission time.
          nullable: true
          type: string
          x-versionadded: v2.11
        downsampledMajorityRows:
          description: the total number of the majority rows available for modeling,
            or null for projects without smart downsampling
          nullable: true
          type: integer
          x-versionadded: v2.5
        downsampledMinorityRows:
          description: the total number of the minority rows available for modeling,
            or null for projects without smart downsampling
          nullable: true
          type: integer
          x-versionadded: v2.5
        eventsCount:
          description: the name of the event count column, if specified, otherwise
            null.
          nullable: true
          type: string
          x-versionadded: v2.8
        exposure:
          description: the name of the exposure column, if specified.
          nullable: true
          type: string
          x-versionadded: v2.6
        majorityDownsamplingRate:
          description: the percentage between 0 and 100 of the majority rows that
            are kept, or null for projects without smart downsampling
          nullable: true
          type: number
          x-versionadded: v2.5
        minSecondaryValidationModelCount:
          description: Compute "All backtest" scores (datetime models) or cross validation
            scores for the specified number of highest ranking models on the Leaderboard,
            if over the Autopilot default.
          type: boolean
          x-versionadded: v2.19
        offset:
          description: the list of names of the offset columns, if specified, otherwise
            null.
          items:
            type: string
          nullable: true
          type: array
          x-versionadded: v2.6
        onlyIncludeMonotonicBlueprints:
          default: false
          description: whether the project only includes blueprints support enforcing
            monotonic constraints
          type: boolean
          x-versionadded: v2.11
        prepareModelForDeployment:
          description: Prepare model for deployment during Autopilot run. The preparation
            includes creating reduced feature list models, retraining best model on
            higher sample size, computing insights and assigning "RECOMMENDED FOR
            DEPLOYMENT" label.
          nullable: true
          type: boolean
          x-versionadded: v2.19
        responseCap:
          description: defaults to False, if specified used to cap the maximum response
            of a model
          oneOf:
          - type: boolean
          - maximum: 1
            minimum: 0.5
            type: number
        runLeakageRemovedFeatureList:
          description: Run Autopilot on Leakage Removed feature list (if exists).
          type: boolean
          x-versionadded: v2.21
        scoringCodeOnly:
          description: Keep only models that can be converted to scorable java code
            during Autopilot run.
          type: boolean
          x-versionadded: v2.19
        seed:
          description: defaults to null, the random seed to be used if specified
          nullable: true
          type: string
        shapOnlyMode:
          description: Keep only models that support SHAP values during Autopilot
            run. Use SHAP-based insights wherever possible. For pre SHAP-only mode
            projects this is always ``null``.
          nullable: true
          type: boolean
          x-versionadded: v2.21
        smartDownsampled:
          description: whether the project uses smart downsampling to throw away excess
            rows of the majority class.  Smart downsampled projects express all sample
            percents in terms of percent of minority rows (as opposed to percent of
            all rows).
          type: boolean
          x-versionadded: v2.5
        weights:
          description: the name of the weight column, if specified, otherwise null.
          nullable: true
          type: string
      required:
      - blendBestModels
      - blueprintThreshold
      - defaultMonotonicDecreasingFeaturelistId
      - defaultMonotonicIncreasingFeaturelistId
      - downsampledMajorityRows
      - downsampledMinorityRows
      - majorityDownsamplingRate
      - onlyIncludeMonotonicBlueprints
      - prepareModelForDeployment
      - responseCap
      - scoringCodeOnly
      - seed
      - shapOnlyMode
      - smartDownsampled
      - weights
      type: object
    ProjectClone:
      properties:
        copyOptions:
          default: false
          description: Whether all project options should be copied to the cloned
            project.
          type: boolean
        projectId:
          description: The ID of the project to clone.
          type: string
        projectName:
          description: The name of the project to be created.
          type: string
      required:
      - projectId
      type: object
    ProjectCreate:
      properties:
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID. Can only be used along with datasetId or dataSourceId.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentials'
          - $ref: '#/components/schemas/S3Credentials'
          - $ref: '#/components/schemas/OAuthCredentials'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentials'
          - $ref: '#/components/schemas/GoogleServiceAccountCredentials'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentials'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentials'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentials'
          x-versionadded: v2.23
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
            Can only be used along with datasetId or dataSourceId.
          type: string
          x-versionadded: v2.19
        dataSourceId:
          description: Identifier for the data source to retrieve.
          type: string
        datasetId:
          description: The ID of the dataset entry to use for the project dataset.
          type: string
        datasetVersionId:
          description: Only used when also providing a datasetId, and specifies the
            the ID of the dataset version to use for the project dataset. If not specified,
            the latest version associated with the dataset ID is used.
          type: string
        password:
          description: 'The password (in cleartext) for database authentication. The
            password will be encrypted on the server side as part of the HTTP request
            and never saved or stored. Can only be used along with datasetId or dataSourceId.
            DEPRECATED: please use credentialId or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
        projectName:
          description: The name of the project to be created. If not specified, 'Untitled
            Project' will be used for database connections and file name will be used
            as the project name.
          type: string
        recipeId:
          description: The ID of the wrangling recipe that will be used for project
            creation.
          type: string
        url:
          description: The URL to download the dataset used to create the project.
          format: url
          type: string
        useKerberos:
          description: If true, use Kerberos authentication for database authentication.
            Default is false. Can only be used along with datasetId or dataSourceId.
          type: boolean
          x-versionadded: v2.19
        user:
          description: 'The username for database authentication. Can only be used
            along with datasetId or dataSourceId. DEPRECATED: please use credentialId
            or credentialData instead.'
          type: string
          x-versiondeprecated: v2.23
      type: object
    ProjectCreateResponse:
      properties:
        pid:
          description: The project ID.
          type: string
      required:
      - pid
      type: object
    ProjectDetailsResponse:
      properties:
        advancedOptions:
          $ref: '#/components/schemas/ProjectAdvancedOptionsResponse'
          description: Information related to the current model of the deployment.
        autopilotClusterList:
          description: Optional. A list of integers where each value will be used
            as the number of clusters in Autopilot model(s) for unsupervised clustering
            projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType
            is set to 'clustering'.
          items:
            maximum: 100
            minimum: 2
            type: integer
          maxItems: 10
          nullable: true
          type: array
          x-versionadded: v2.25
        autopilotMode:
          description: The current autopilot mode, 0 for full autopilot, 2 for manual
            mode, 3 for quick mode, 4 for comprehensive mode
          type: integer
        created:
          description: The time of project creation.
          format: date-time
          type: string
        featureEngineeringPredictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          nullable: true
          type: string
          x-versionadded: v2.22
        fileName:
          description: The name of the dataset used to create the project.
          type: string
        holdoutUnlocked:
          description: whether the holdout has been unlocked
          type: boolean
        id:
          description: The ID of a project.
          type: string
        maxClusters:
          description: Only valid when unsupervisedMode is True and unsupervisedType
            is 'clustering'. The maximum number of clusters allowed when training
            clustering models. If specified cannot be exceed the number of rows in
            a project's dataset divided by 50 and must be less than or equal to `minClusters`.
            If unsupervisedMode is True and unsupervisedType is 'clustering' then
            defaults to the number of rows in the project's dataset divided by 50
            or 100 if that number of greater than 100.
          maximum: 100
          minimum: 2
          nullable: true
          type: integer
          x-versionadded: v2.23
        maxTrainPct:
          description: the maximum percentage of the dataset that can be used to successfully
            train a model without going into the validation data.
          type: number
        maxTrainRows:
          description: the maximum number of rows of the dataset that can be used
            to successfully train a model without going into the validation data
          type: integer
        metric:
          description: the metric used to select the best-performing models.
          type: string
        minClusters:
          description: Only valid when unsupervisedMode is True and unsupervisedType
            is 'clustering'. The minimum number of clusters allowed when training
            clustering models. If specified cannot be exceed the number of rows in
            a project's dataset divided by 50 and must be less than or equal to `maxClusters`.
            If unsupervisedMode is True and  unsupervisedType is 'clustering' then
            defaults to 2.
          maximum: 100
          minimum: 2
          nullable: true
          type: integer
          x-versionadded: v2.23
        partition:
          $ref: '#/components/schemas/ProjectPartitionResponse'
          description: The partition object of a project indicates the settings used
            for partitioning.  Depending on the partitioning selected, many of the
            options will be null. Note that for projects whose `cvMethod` is `"datetime"`,
            full specification of the partitioning method can be found at :http:get:`/api/v2/projects/(projectId)/datetimePartitioning/`.
        positiveClass:
          description: if the project uses binary classification, the class designated
            to be the positive class.  Otherwise, null.
          nullable: true
          type: number
        projectName:
          description: The name of a project.
          type: string
        stage:
          description: the stage of the project - if modeling, then the target is
            successfully set, and modeling or predictions can proceed.
          type: string
        target:
          description: the target of the project, null if project is unsupervised.
          type: string
        targetType:
          description: The target type of the project.
          enum:
          - Binary
          - Regression
          - Multiclass
          - minInflated
          - Multilabel
          - TextGeneration
          nullable: true
          type: string
        unsupervisedMode:
          description: indicates whether a project is unsupervised.
          type: boolean
          x-versionadded: v2.20
        unsupervisedType:
          description: Only valid when unsupervisedMode is True. The type of unsupervised
            project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.23
        useFeatureDiscovery:
          description: A boolean value indicating whether a feature discovery project
            was created as opposed to a regular project.
          type: boolean
          x-versionadded: v2.21
      required:
      - advancedOptions
      - autopilotMode
      - created
      - fileName
      - holdoutUnlocked
      - id
      - maxTrainPct
      - maxTrainRows
      - metric
      - partition
      - positiveClass
      - projectName
      - stage
      - target
      - targetType
      - unsupervisedMode
      - useFeatureDiscovery
      type: object
    ProjectFeatureResponse:
      properties:
        dataQualities:
          description: Data Quality Status
          enum:
          - ISSUES_FOUND
          - NOT_ANALYZED
          - NO_ISSUES_FOUND
          type: string
        dateFormat:
          description: the date format string for how this feature was interpreted
            (or null if not a date feature).  If not null, it will be compatible with
            https://docs.python.org/2/library/time.html#time.strftime .
          nullable: true
          type: string
          x-versionadded: v2.5
        featureLineageId:
          description: id of a lineage for automatically generated features.
          nullable: true
          type: string
          x-versionadded: v2.21
        featureType:
          description: Feature type.
          enum:
          - Boolean
          - Categorical
          - Currency
          - Date
          - Date Duration
          - Document
          - Image
          - Interaction
          - Length
          - Location
          - Multicategorical
          - Numeric
          - Percentage
          - Summarized Categorical
          - Text
          - Time
          type: string
        id:
          description: 'the feature ID. (Note: Throughout the API, features are specified
            using their names, not this ID.)'
          type: integer
        importance:
          description: numeric measure of the strength of relationship between the
            feature and target (independent of any model or other features)
          nullable: true
          type: number
        isRestoredAfterReduction:
          description: Whether feature is restored after feature reduction
          type: boolean
          x-versionadded: v2.26
        isZeroInflated:
          description: Whether feature has an excessive number of zeros
          nullable: true
          type: boolean
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            description: For a Summarized Categorical columns, this will contain statistics
              for the top 50 keys (truncated to 103 characters)
            x-versionadded: v2.18
          - description: For a Multicategorical columns, this will contain statistics
              for the top classes
            items:
              $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorMultilabel'
            type: array
            x-versionadded: v2.24
        language:
          description: Feature's detected language.
          type: string
          x-versionadded: v2.32
        lowInformation:
          description: whether feature has too few values to be informative
          type: boolean
        max:
          description: maximum value of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: maximum value of the EDA sample of the feature.
            type: string
          - description: maximum value of the EDA sample of the feature.
            type: number
        mean:
          description: arithmetic mean of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: arithmetic mean of the EDA sample of the feature.
            type: string
          - description: arithmetic mean of the EDA sample of the feature.
            type: number
        median:
          description: median of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: median of the EDA sample of the feature.
            type: string
          - description: median of the EDA sample of the feature.
            type: number
        min:
          description: minimum value of the EDA sample of the feature.
          nullable: true
          oneOf:
          - description: minimum value of the EDA sample of the feature.
            type: string
          - description: minimum value of the EDA sample of the feature.
            type: number
        multilabelInsights:
          $ref: '#/components/schemas/MultilabelInsightsResponse'
          description: Multilabel project specific information
          x-versionadded: v2.24
        naCount:
          description: number of missing values
          type: integer
        name:
          description: feature name
          type: string
        parentFeatureNames:
          description: an array of string feature names indicating which features
            in the input data were used to create this feature if the feature is a
            transformation.
          items:
            type: string
          type: array
        projectId:
          description: the ID of the project the feature belongs to
          type: string
        stdDev:
          description: standard deviation of EDA sample of the feature.
          nullable: true
          oneOf:
          - description: standard deviation of EDA sample of the feature.
            type: string
          - description: standard deviation of EDA sample of the feature.
            type: number
        targetLeakage:
          description: the detected level of risk for target leakage, if any. 'SKIPPED_DETECTION'
            indicates leakage detection was not run on the feature, 'FALSE' indicates
            no leakage, 'MODERATE_RISK' indicates a moderate risk of target leakage,
            and 'HIGH_RISK' indicates a high risk of target leakage.
          enum:
          - 'FALSE'
          - HIGH_RISK
          - MODERATE_RISK
          - SKIPPED_DETECTION
          type: string
        targetLeakageReason:
          description: descriptive sentence explaining the reason for target leakage.
          type: string
          x-versionadded: v2.20
        timeSeriesEligibilityReason:
          description: why the feature is ineligible for time series projects, or
            'suitable' if it is eligible.
          type: string
          x-versionadded: v2.8
        timeSeriesEligible:
          description: whether this feature can be used as a datetime partitioning
            feature for time series projects.  Only sufficiently regular date features
            can be selected as the datetime feature for time series projects.  Always
            false for non-date features.  Date features that cannot be used in datetime
            partitioning for a time series project may be eligible for an OTV project,
            which has less stringent requirements.
          type: boolean
          x-versionadded: v2.8
        timeStep:
          description: The minimum time step that can be used to specify time series
            windows.  The units for this value are the ``timeUnit``.  When specifying
            windows for time series projects, all windows must have durations that
            are integer multiples of this number.  Only present for date features
            that are eligible for time series projects and null otherwise.
          nullable: true
          type: integer
          x-versionadded: v2.8
        timeUnit:
          description: the unit for the interval between values of this feature, e.g.
            DAY, MONTH, HOUR.  When specifying windows for time series projects, the
            windows are expressed in terms of this unit.  Only present for date features
            eligible for time series projects, and null otherwise.
          nullable: true
          type: string
          x-versionadded: v2.8
        uniqueCount:
          description: number of unique values
          type: integer
      required:
      - dateFormat
      - featureLineageId
      - featureType
      - id
      - importance
      - lowInformation
      - max
      - mean
      - median
      - min
      - naCount
      - name
      - projectId
      - stdDev
      - targetLeakage
      - targetLeakageReason
      - timeSeriesEligibilityReason
      - timeSeriesEligible
      - timeStep
      - timeUnit
      type: object
    ProjectNuke:
      properties:
        creator:
          description: Creator ID to filter projects by
          type: string
        deletedAfter:
          description: ISO-8601 formatted date projects were deleted after
          format: date-time
          type: string
        deletedBefore:
          description: ISO-8601 formatted date projects were deleted before
          format: date-time
          type: string
        limit:
          default: 1000
          description: At most this many projects are deleted.
          maximum: 1000
          minimum: 1
          type: integer
        offset:
          default: 0
          description: This many projects will be skipped.
          minimum: 0
          type: integer
        organization:
          description: ID of organization that projects should belong to
          type: string
        projectIds:
          description: List of project IDs to delete permanently.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
        searchFor:
          description: Project or dataset name to filter by
          type: string
      type: object
    ProjectNukeJobListStatus:
      properties:
        jobs:
          description: List of active permadelete jobs with their statuses.
          items:
            $ref: '#/components/schemas/ProjectNukeJobStatus'
          type: array
      required:
      - jobs
      type: object
    ProjectNukeJobStatus:
      properties:
        created:
          description: The time the status record was created.
          format: date-time
          type: string
        data:
          description: List of projects and associated statuses.
          items:
            $ref: '#/components/schemas/ProjectPermadeleteStatus'
          maxItems: 1000
          minItems: 1
          type: array
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        status:
          description: The processing state of the cleanup job.
          enum:
          - ABORTED
          - BLOCKED
          - COMPLETED
          - CREATED
          - ERROR
          - EXPIRED
          - INCOMPLETE
          - INITIALIZED
          - PAUSED
          - RUNNING
          type: string
        statusId:
          description: The ID of the status object.
          type: string
      required:
      - created
      - data
      - message
      - status
      - statusId
      type: object
    ProjectNukeJobStatusSummary:
      properties:
        jobId:
          description: The ID of the permadeletion multi-job.
          type: string
        summary:
          $ref: '#/components/schemas/ProjectNukeJobStatusSummaryObject'
          description: Project permanent deletion status to count mapping.
      required:
      - jobId
      - summary
      type: object
    ProjectNukeJobStatusSummaryObject:
      properties:
        aborted:
          description: Number of project permadelete jobs with Aborted status.
          minimum: 0
          type: integer
        completed:
          description: Number of project permadelete jobs with Completed status.
          minimum: 0
          type: integer
        error:
          description: Number of project permadelete jobs with Error status.
          minimum: 0
          type: integer
        expired:
          description: Number of project permadelete jobs with Expired status.
          minimum: 0
          type: integer
      required:
      - aborted
      - completed
      - error
      - expired
      type: object
    ProjectOptions:
      properties:
        cvMethod:
          description: The partitioning method for projects used to build new models.
          enum:
          - RandomCV
          - StratifiedCV
          type: string
        holdoutPct:
          default: null
          description: The percentage of dataset to assign to holdout set in projects
            used to build new models.
          maximum: 98.0
          minimum: 0.0
          nullable: true
          type: number
        metric:
          default: null
          description: The model selection metric in projects used to build new models.
          enum:
          - Accuracy
          - AUC
          - Balanced Accuracy
          - FVE Binomial
          - Gini Norm
          - Kolmogorov-Smirnov
          - LogLoss
          - Rate@Top5%
          - Rate@Top10%
          - TPR
          - FPR
          - TNR
          - PPV
          - NPV
          - F1
          - MCC
          - FVE Gamma
          - FVE Poisson
          - FVE Tweedie
          - Gamma Deviance
          - MAE
          - MAPE
          - Poisson Deviance
          - R Squared
          - RMSE
          - RMSLE
          - Tweedie Deviance
          nullable: true
          type: string
        reps:
          default: null
          description: The number of cross validation folds to use for projects used
            to build new models.
          maximum: 50.0
          minimum: 2.0
          nullable: true
          type: integer
        validationPct:
          default: null
          description: The percentage of dataset to assign to validation set in projects
            used to build new models.
          maximum: 99.0
          minimum: 1.0
          nullable: true
          type: number
        validationType:
          description: The validation type for projects used to build new models.
          enum:
          - CV
          - TVH
          type: string
      type: object
    ProjectPartitionResponse:
      properties:
        cvHoldoutLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          description: if a user partition column was used with cross validation,
            the value assigned to the holdout set
          nullable: true
        cvMethod:
          description: the partitioning method used. Note that "date" partitioning
            is an old partitioning method no longer supported for new projects, as
            of API version v2.0.
          enum:
          - random
          - user
          - stratified
          - group
          - datetime
          type: string
        datetimeCol:
          description: if a date partition column was used, the name of the column.
            Note that datetimeCol applies to an old partitioning method no longer
            supported for new projects, as of API version v2.0.
          nullable: true
          type: string
        datetimePartitionColumn:
          description: if a datetime partition column was used, the name of the column
          type: string
        holdoutLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          description: if a user partition column was used with train-validation-holdout
            split, the value assigned to the holdout set
          nullable: true
        holdoutPct:
          description: the percentage of the dataset reserved for the holdout set
          type: number
        partitionKeyCols:
          description: An array containing a single string - the name of the group
            partition column
          items:
            type: string
          nullable: true
          type: array
        reps:
          description: if cross validation was used, the number of folds to use
          nullable: true
          type: number
        trainingLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          description: if a user partition column was used with train-validation-holdout
            split, the value assigned to the training set
          nullable: true
        useTimeSeries:
          description: A boolean value indicating whether a time series project was
            created as opposed to a regular project using datetime partitioning.
          nullable: true
          type: boolean
          x-versionadded: v2.9
        userPartitionCol:
          description: if a user partition column was used, the name of the column
          nullable: true
          type: string
        validationLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          description: if a user partition column was used with train-validation-holdout
            split, the value assigned to the validation set
          nullable: true
        validationPct:
          description: if train-validation-holdout split was used, the percentage
            of the dataset used for the validation set
          nullable: true
          type: number
        validationType:
          description: either CV for cross-validation or TVH for train-validation-holdout
            split
          enum:
          - CV
          - TVH
          type: string
      required:
      - cvHoldoutLevel
      - cvMethod
      - datetimeCol
      - holdoutLevel
      - holdoutPct
      - partitionKeyCols
      - reps
      - trainingLevel
      - useTimeSeries
      - userPartitionCol
      - validationLevel
      - validationPct
      - validationType
      type: object
    ProjectPermadeleteStatus:
      properties:
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        projectId:
          description: Project ID
          type: string
        status:
          description: The processing state of project cleanup task.
          enum:
          - ABORTED
          - BLOCKED
          - COMPLETED
          - CREATED
          - ERROR
          - EXPIRED
          - INCOMPLETE
          - INITIALIZED
          - PAUSED
          - RUNNING
          type: string
      required:
      - message
      - projectId
      - status
      type: object
    ProjectRecover:
      properties:
        action:
          description: Action to perform on a project
          enum:
          - undelete
          type: string
      required:
      - action
      type: object
    ProjectRecoverResponse:
      properties:
        message:
          description: Operation result description
          type: string
      required:
      - message
      type: object
    ProjectRetrieveResponse:
      properties:
        advancedOptions:
          $ref: '#/components/schemas/ProjectAdvancedOptionsResponse'
          description: Advanced Settings for the project.
        autopilotClusterList:
          description: Optional. A list of integers where each value will be used
            as the number of clusters in Autopilot model(s) for unsupervised clustering
            projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType
            is set to 'clustering'.
          items:
            maximum: 100
            minimum: 2
            type: integer
          maxItems: 10
          nullable: true
          type: array
          x-versionadded: v2.25
        autopilotMode:
          description: 'The current autopilot mode. 0: Full Autopilot. 2: Manual Mode.
            3: Quick Mode. 4: Comprehensive Autopilot. null: Mode not set.'
          enum:
          - '0'
          - '2'
          - '3'
          - '4'
          nullable: true
          type: string
        catalogId:
          description: The ID of the AI catalog entry used to create the project,
            or null if not created from the AI catalog.
          nullable: true
          type: string
          x-versionadded: v2.21
        catalogVersionId:
          description: The ID of the AI catalog version used to create the project,
            or null if not created from the AI catalog.
          nullable: true
          type: string
          x-versionadded: v2.21
        created:
          description: The time of project creation.
          format: date-time
          type: string
        externalTimeSeriesBaselineDatasetMetadata:
          $ref: '#/components/schemas/ExternalTSBaselineMetadata'
          description: The id of the catalog item that is being used as the external
            baseline data
          nullable: true
          x-versionadded: v2.24
        featureEngineeringPredictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          nullable: true
          type: string
          x-versionadded: v2.22
        fileName:
          description: The name of the dataset used to create the project.
          type: string
        holdoutUnlocked:
          description: Whether the holdout has been unlocked.
          type: boolean
        id:
          description: The ID of the project.
          type: string
        isScoringAvailableForModelsTrainedIntoValidationHoldout:
          description: Indicates whether validation scores are available. A result
            of 'N/A' in the UI indicates that a model was trained into validation
            or holdout and also either does not have stacked predictions or uses extended
            multiclass.
          type: boolean
          x-versionadded: v2.31
        maxClusters:
          description: Only valid when unsupervisedMode is True and unsupervisedType
            is 'clustering'. The maximum number of clusters allowed when training
            clustering models. If specified cannot be exceed the number of rows in
            a project's dataset divided by 50 and must be less than or equal to `minClusters`.
            If unsupervisedMode is True and unsupervisedType is 'clustering' then
            defaults to the number of rows in the project's dataset divided by 50
            or 100 if that number of greater than 100.
          maximum: 100
          minimum: 2
          nullable: true
          type: integer
          x-versionadded: v2.23
        maxTrainPct:
          description: The maximum percentage of the dataset that can be used to successfully
            train a model without going into the validation data.
          type: number
        maxTrainRows:
          description: The maximum number of rows of the dataset that can be used
            to successfully train a model without going into the validation data.
          type: integer
        metric:
          description: The metric used to select the best-performing models.
          type: string
        minClusters:
          description: Only valid when unsupervisedMode is True and unsupervisedType
            is 'clustering'. The minimum number of clusters allowed when training
            clustering models. If specified cannot be exceed the number of rows in
            a project's dataset divided by 50 and must be less than or equal to `maxClusters`.
            If unsupervisedMode is True and  unsupervisedType is 'clustering' then
            defaults to 2.
          maximum: 100
          minimum: 2
          nullable: true
          type: integer
          x-versionadded: v2.23
        partition:
          $ref: '#/components/schemas/Partition'
          description: The partition object of a project indicates the settings used
            for partitioning. Depending on the partitioning selected, many of the
            options will be null.
        positiveClass:
          description: If the project uses binary classification, the class designated
            to be the positive class.
          nullable: true
          oneOf:
          - type: string
          - type: integer
        primaryLocationColumn:
          description: Primary location column name
          type: string
          x-versionadded: v2.27
        projectName:
          description: The name of the project.
          type: string
        queryGeneratorId:
          description: The ID of the time series data prep query generator associated
            with the project, or null if there is no associated query generator.
          nullable: true
          type: string
          x-versionadded: v2.27
        quickrun:
          description: 'If the Autopilot mode is set to quick. DEPRECATED: look at
            autopilot_mode instead.'
          type: boolean
          x-versionadded: v2.22
          x-versiondeprecated: v2.30
        relationshipsConfigurationId:
          description: Relationships configuration id to be used for Feature Discovery
            projects.
          nullable: true
          type: string
          x-versionadded: v2.27
        segmentation:
          $ref: '#/components/schemas/ProjectSegmentationInfoResponse'
          description: Segmentation info for the project.
          nullable: true
          x-versionadded: v2.24
        stage:
          description: The stage of the project. If modeling, then the target is successfully
            set and modeling or predictions can proceed.
          enum:
          - modeling
          - aim
          - fasteda
          - eda
          - eda2
          - empty
          type: string
        target:
          description: The target of the project, null if project is unsupervised.
          type: string
        targetType:
          description: The type of the selected target. Null if the project is unsupervised.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Multilabel
          nullable: true
          type: string
        unsupervisedMode:
          description: Indicates whether a project is unsupervised.
          nullable: true
          type: boolean
          x-versionadded: v2.20
        unsupervisedType:
          description: Only valid when unsupervisedMode is True. The type of unsupervised
            project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.
          enum:
          - anomaly
          - clustering
          nullable: true
          type: string
          x-versionadded: v2.23
        useFeatureDiscovery:
          description: Indicates whether a feature discovery project was created as
            opposed to a regular project
          type: boolean
          x-versionadded: v2.21
        useGpu:
          description: Indicates whether project should use GPU workers
          nullable: true
          type: boolean
          x-versionadded: v2.31
      required:
      - advancedOptions
      - autopilotMode
      - catalogId
      - catalogVersionId
      - created
      - fileName
      - holdoutUnlocked
      - id
      - isScoringAvailableForModelsTrainedIntoValidationHoldout
      - maxTrainPct
      - maxTrainRows
      - metric
      - partition
      - positiveClass
      - projectName
      - queryGeneratorId
      - quickrun
      - stage
      - target
      - targetType
      - unsupervisedMode
      - useFeatureDiscovery
      type: object
    ProjectSecondaryDatasetConfigResponse:
      properties:
        config:
          description: Graph-specific secondary datasets. Deprecated in version v2.23.
          items:
            $ref: '#/components/schemas/SecondaryDatasetConfig'
          nullable: true
          type: array
        created:
          description: DR-formatted datetime, null for legacy (before DR 6.0) db records.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.24
        creatorFullName:
          description: Fullname or email of the user created this config. null for
            legacy (before DR 6.0) db records.
          nullable: true
          type: string
          x-versionadded: v2.24
        creatorUserId:
          description: ID of the user created this config, null for legacy (before
            DR 6.0) db records.
          nullable: true
          type: string
          x-versionadded: v2.24
        credentialIds:
          description: List of credentials used by the secondary datasets if the datasets
            used in the configuration are from datasource.
          items:
            $ref: '#/components/schemas/DatasetsCredential'
          nullable: true
          type: array
        featurelistId:
          description: Id of the feature list.
          nullable: true
          type: string
          x-versionadded: v2.24
        id:
          description: ID of the secondary datasets configuration.
          type: string
        isDefault:
          description: Secondary datasets config is default config or not.
          nullable: true
          type: boolean
        name:
          description: Name of the secondary datasets config.
          nullable: true
          type: string
        projectId:
          description: ID of the project.
          nullable: true
          type: string
        projectVersion:
          description: DataRobot project version.
          nullable: true
          type: string
        secondaryDatasets:
          description: List of secondary datasets used in the config.
          items:
            $ref: '#/components/schemas/SecondaryDatasetResponse'
          type: array
          x-versionadded: v2.24
      required:
      - created
      - creatorFullName
      - creatorUserId
      - id
      - isDefault
      - name
      - projectId
      type: object
    ProjectSegmentUpdate:
      properties:
        operation:
          default: restart
          description: Name of operation to do on project segment
          enum:
          - restart
          type: string
      type: object
    ProjectSegmentUpdateResponse:
      properties:
        projectId:
          description: New project id of the restarted segment
          type: string
        segmentId:
          description: The name of the restarted segment
          type: string
      required:
      - projectId
      - segmentId
      type: object
    ProjectSegmentationInfoResponse:
      properties:
        parentProjectId:
          description: ID of the original project.
          nullable: true
          type: string
        segment:
          description: Segment value.
          nullable: true
          type: string
        segmentationTaskId:
          description: ID of the Segmentation Task.
          type: string
      required:
      - segmentationTaskId
      type: object
    ProjectStatusResponse:
      properties:
        autopilotDone:
          description: whether the current autopilot run has finished
          type: boolean
        stage:
          description: the current stage of the project, where modeling indicates
            that the target has been successfully set and modeling and predictions
            may proceed
          enum:
          - modeling
          - aim
          - fasteda
          - eda
          - eda2
          - empty
          type: string
        stageDescription:
          description: a description of the current stage of the project
          type: string
      required:
      - autopilotDone
      - stage
      - stageDescription
      type: object
    ProjectUpdate:
      properties:
        gpuWorkerCount:
          description: "The desired new number of gpu workers if the\n           \
            \ number of gpu workers should be changed.\n            Must not exceed\
            \ the number of gpu workers available to the user. `0` is allowed.\n \
            \           `-1` requests the maximum number available to the user."
          type: integer
        holdoutUnlocked:
          description: "If specified, the holdout will be unlocked;\n            note\
            \ that the holdout cannot be relocked after unlocking"
          enum:
          - 'True'
          type: string
        projectDescription:
          description: The new description of the project, if the description should
            be updated.
          maxLength: 500
          type: string
          x-versionadded: v2.20
        projectName:
          description: The new name of the project, if it should be renamed.
          maxLength: 100
          type: string
        workerCount:
          description: "The desired new number of workers if the\n            number\
            \ of workers should be changed.\n            Must not exceed the number\
            \ of workers available to the user. `0` is allowed.\n            (New\
            \ in version v2.14) `-1` requests the maximum number available to the\
            \ user."
          type: integer
      type: object
    RandomSampleArgumentsCreate:
      properties:
        rows:
          default: 10000
          description: The number of rows to be sampled.
          maximum: 10000
          minimum: 1
          type: integer
          x-versionadded: v2.33
        seed:
          default: 0
          description: The starting number of the random number generator.
          minimum: 0
          type: integer
          x-versionadded: v2.33
      type: object
    RatingTableCreateResponse:
      properties:
        ratingTableId:
          description: the ID of the newly created rating table
          type: string
        ratingTableName:
          description: The name that was used for the rating table. May differ from
            the ratingTableName in the request, as names are trimmed and a suffix
            added to ensure all rating tables derived from the same model have unique
            names
          type: string
      required:
      - ratingTableId
      - ratingTableName
      type: object
    RatingTableListResponse:
      properties:
        count:
          description: the number of RatingTable objects returned
          type: integer
        data:
          description: "the actual records. Each element of the array has the same\
            \ schema\n        as if retrieving the table individually from\n     \
            \   GET /api/v2/projects/(projectId)/ratingTables/(ratingTableId)/"
          items:
            $ref: '#/components/schemas/RatingTableRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    RatingTableModelDetailsResponse:
      properties:
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
        dataSelectionMethod:
          description: Identifies which setting defines the training size of the model
            when making predictions and scoring. Only used by datetime models.
          enum:
          - duration
          - rowCount
          - selectedDateRange
          - useProjectSettings
          type: string
        featurelistId:
          description: the ID of the featurelist used by the model
          nullable: true
          type: string
        featurelistName:
          description: the name of the featurelist used by the model.If null, the
            model was trained on multiple feature lists.
          nullable: true
          type: string
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        id:
          description: the ID of the model
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
        isNClustersDynamicallyDetermined:
          description: Whether number of clusters is dynamically determined. Only
            valid in unsupervised clustering projects.
          type: boolean
        isStarred:
          description: whether the model has been starred
          type: boolean
        isTrainedIntoHoldout:
          description: Indicates if model used holdout data for training. This can
            happen for time-aware models using trainingStartDate/trainingEndDate parameters
            or whenthe model's training row count was greater than the max allowed
            validation size.
          type: boolean
        isTrainedIntoValidation:
          description: Indicates if model used validation data for training. This
            can happen for time-aware models using trainingStartDate/trainingEndDate
            parameters or when the model's training row count was greater than the
            max allowed training size.
          type: boolean
        isTrainedOnGpu:
          description: Whether the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.33
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          description: Object returning model lifecycle.
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          nullable: true
          type: string
          x-versionadded: v2.21
        metrics:
          description: the performance of the model according to various metrics,
            where each metric has validation, crossValidation, holdout, and training
            scores reported, or null if they have not been computed.
          example: "\n        {\n            \"metrics\": {\n                \"RMSE\"\
            : {\n                    \"holdout\": 5000,\n                    \"validation\"\
            : 5100,\n                    \"backtesting\": null,\n                \
            \    \"backtestingScores\": null,\n                    \"crossValidation\"\
            : 6000,\n                    \"training\": null\n                },\n\
            \                \"FVE Poisson\": {\n                    \"holdout\":\
            \ null,\n                    \"validation\": 0.56269,\n              \
            \      \"crossValidation\": 0.50166,\n                    \"backtesting\"\
            : null,\n                    \"backtestingScores\": null,\n          \
            \          \"training\": null\n                },\n            }\n   \
            \     }\n"
          type: object
        modelCategory:
          description: Indicates the kind of model. Returns `prime` for DataRobot
            Prime models, `blend` for blender models, `combined` for combined models,
            and `model` for all other models.
          enum:
          - model
          - prime
          - blend
          - combined
          - incrementalLearning
          type: string
        modelFamily:
          description: the family model belongs to, e.g. SVM, GBM, etc.
          type: string
          x-versionadded: v2.21
        modelFamilyFullName:
          description: The full name of the family that the model belongs to. For
            e.g., Support Vector Machine, Gradient Boosting Machine, etc.
          type: string
          x-versionadded: v2.31
        modelNumber:
          description: The model number from the leaderboard.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        modelType:
          description: identifies the model, e.g. `Nystroem Kernel SVM Regressor`
          type: string
        monotonicDecreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        monotonicIncreasingFeaturelistId:
          description: the ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          nullable: true
          type: integer
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          nullable: true
          type: string
        predictionThreshold:
          description: threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
          x-versionadded: v2.13
        predictionThresholdReadOnly:
          description: indicates whether modification of a predictions threshold is
            forbidden. Since v2.22 threshold modification is allowed.
          type: boolean
          x-versionadded: v2.13
        processes:
          description: list of processes used by the model
          items:
            type: string
          nullable: true
          type: array
        projectId:
          description: the ID of the project to which the model belongs
          type: string
        ratingTableId:
          description: The rating table ID
          type: string
        samplePct:
          description: the percentage of the dataset used in training the model
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: number
        samplingMethod:
          description: indicates sampling method used to select training data in datetime
            models. For row-based project this is the way how requested number of
            rows are selected.For other projects (duration-based, start/end, project
            settings) - how specified percent of rows (timeWindowSamplePct) is selected
            from specified time window.
          enum:
          - random
          - latest
          type: string
        supportsComposableMl:
          description: indicates whether this model is supported in Composable ML.
          type: boolean
          x-versionadded: '2.26'
        supportsMonotonicConstraints:
          description: whether this model supports enforcing monotonic constraints
          type: boolean
          x-versionadded: v2.21
        timeWindowSamplePct:
          description: An integer between 1 and 99, indicating the percentage of sampling
            within the time window. The points kept are determined by samplingMethod
            option. Will be null if no sampling was specified. Only used by datetime
            models.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          nullable: true
          type: string
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          nullable: true
          type: string
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: true
          minimum: 0
          nullable: true
          type: integer
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          nullable: true
          type: string
      required:
      - blueprintId
      - featurelistId
      - featurelistName
      - id
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - lifecycle
      - linkFunction
      - metrics
      - modelCategory
      - modelFamily
      - modelFamilyFullName
      - modelNumber
      - modelType
      - monotonicDecreasingFeaturelistId
      - monotonicIncreasingFeaturelistId
      - parentModelId
      - predictionThreshold
      - predictionThresholdReadOnly
      - processes
      - projectId
      - ratingTableId
      - samplePct
      - supportsComposableMl
      - supportsMonotonicConstraints
      - trainingDuration
      - trainingEndDate
      - trainingRowCount
      - trainingStartDate
      type: object
    RatingTableRetrieveResponse:
      properties:
        created:
          description: ISO-8601 timestamp of when the rating table record was created.
          type: number
        id:
          description: the ID of the rating table record
          type: string
        modelId:
          description: "the model ID of a model that was created from the rating table.\n\
            \        May be null if a model has not been created from the rating table."
          type: string
        modelJobId:
          description: "the qid of the job to create a model from this rating table.\n\
            \        Can be null if a model has not been created from the rating table."
          type: integer
        originalFilename:
          description: the filename of the uploaded rating table file
          type: string
        parentModelId:
          description: the model ID of the model the rating table was modified from
          type: string
        projectId:
          description: the project ID of the rating table record
          type: string
        ratingTableName:
          description: the name of the rating table
          type: string
        validationError:
          description: "rating table validation error messages. If the rating table\n\
            \        was validated successfully, it will be an empty string."
          type: string
        validationJobId:
          description: "the qid of the created job to validate the rating table.\n\
            \        Can be null if the rating table has not been validated."
          type: string
        validationWarnings:
          description: rating table validation warning messages.
          type: string
      required:
      - created
      - id
      - modelId
      - modelJobId
      - originalFilename
      - parentModelId
      - projectId
      - ratingTableName
      - validationError
      - validationJobId
      - validationWarnings
      type: object
    RatingTableUpdate:
      properties:
        ratingTableName:
          description: the name of the new model
          type: string
      required:
      - ratingTableName
      type: object
    Reasons:
      properties:
        supportsConfusionMatrix:
          description: If present, the reason why Confusion Matrix cannot be generated
            for the model. There are some cases where Confusion Matrix is available
            but it was calculated using stacked predictions or in-sample predictions.
          type: string
          x-versionadded: v2.33
        supportsDocumentTextExtractionSampleInsight:
          description: If present, the reason document text extraction sample insights
            are not supported for the model.
          type: string
          x-versionadded: v2.29
        supportsImageActivationMaps:
          description: If present, the reason image activation maps are not supported
            for the model.
          type: string
        supportsImageEmbedding:
          description: If present, the reason image embeddings are not supported for
            the model.
          type: string
        supportsLiftChart:
          description: If present, the reason why Lift Chart cannot be generated for
            the model. There are some cases where Lift Chart is available but it was
            calculated using stacked predictions or in-sample predictions.
          type: string
          x-versionadded: v2.31
        supportsResiduals:
          description: If present, the reason why residuals are not available for
            the model. There are some cases where Residuals are available but they
            were calculated using stacked predictions or in-sample predictions.
          type: string
          x-versionadded: v2.30
        supportsRocCurve:
          description: If present, the reason why ROC Curve cannot be generated for
            the model. There are some cases where ROC Curve is available but it was
            calculated using stacked predictions or in-sample predictions.
          type: string
          x-versionadded: v2.32
      type: object
    RecipeDownsamplingUpdate:
      properties:
        downsampling:
          $ref: '#/components/schemas/OneOfDownsamplingDirective'
          description: Downsampling directive to apply during publishing
          nullable: true
          x-versionadded: v2.33
      required:
      - downsampling
      type: object
    RecipeFromDataSourceCreate:
      properties:
        dataSourceType:
          description: Data source type.
          enum:
          - dr-database-v1
          - jdbc
          type: string
          x-versionadded: v2.33
        dataStoreId:
          description: Data store ID for this data source.
          type: string
          x-versionadded: v2.33
        dialect:
          description: Source type data was retrieved from.
          enum:
          - snowflake
          - bigquery
          - databricks
          - spark
          type: string
          x-versionadded: v2.33
        experimentContainerId:
          description: '[DEPRECATED - replaced with use_case_id] ID assigned to the
            Use Case, which is an experimental container for the recipe.'
          type: string
          x-versionadded: v2.33
        inputs:
          description: List of recipe inputs
          items:
            $ref: '#/components/schemas/JDBCTableDataSourceInputCreate'
            description: Data source configuration.
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
        useCaseId:
          description: ID of the Use Case associated with the recipe.
          type: string
          x-versionadded: v2.33
      required:
      - dataSourceType
      - dataStoreId
      - dialect
      - inputs
      type: object
    RecipeFromRecipeCreate:
      properties:
        name:
          description: The recipe name.
          maxLength: 255
          type: string
          x-versionadded: v2.33
        recipeId:
          description: Recipe ID to create a Recipe from.
          type: string
          x-versionadded: v2.33
      required:
      - recipeId
      type: object
    RecipeInputResponse:
      discriminator:
        propertyName: inputType
      oneOf:
      - properties:
          alias:
            description: The alias for the data source table.
            maxLength: 256
            type: string
          dataSourceId:
            description: The ID of the input data source.
            type: string
          dataStoreId:
            description: The ID of the input data store.
            type: string
          inputType:
            description: The data that comes from a database connection.
            enum:
            - datasource
            type: string
          sampling:
            $ref: '#/components/schemas/SampleDirectiveCreate'
            default: null
            description: The input data transformation steps.
            nullable: true
        required:
        - alias
        - dataSourceId
        - dataStoreId
        - inputType
        type: object
      - properties:
          alias:
            description: The alias for the data source table.
            maxLength: 256
            type: string
          datasetId:
            description: The ID of the input data store.
            type: string
          datasetVersionId:
            description: The ID of the input data source.
            type: string
          inputType:
            description: The data that comes from the Data Registry.
            enum:
            - dataset
            type: string
          sampling:
            $ref: '#/components/schemas/SampleDirectiveCreate'
            default: null
            description: The input data transformation steps.
            nullable: true
        required:
        - alias
        - datasetId
        - datasetVersionId
        - inputType
        type: object
    RecipeInputStatsResponse:
      properties:
        columnCount:
          description: Number of features in original (not sampled) data source
          nullable: true
          type: integer
          x-versionadded: v2.33
        connectionName:
          description: The user-friendly name of the data store.
          nullable: true
          type: string
          x-versionadded: v2.33
        dataSourceId:
          description: ID of the input data source
          type: string
          x-versionadded: v2.33
        dataStoreId:
          description: ID of the input data store
          type: string
          x-versionadded: v2.33
        inputType:
          description: Source type data came from
          enum:
          - datasource
          - dataset
          type: string
          x-versionadded: v2.33
        name:
          description: Combination of "catalog", "schema" and "table" from data source
          nullable: true
          type: string
          x-versionadded: v2.33
        rowCount:
          description: Number of rows in original (not sampled) data source
          nullable: true
          type: integer
          x-versionadded: v2.33
        status:
          description: Input preparation status
          enum:
          - ABORTED
          - COMPLETED
          - ERROR
          - EXPIRED
          - INITIALIZED
          - RUNNING
          type: string
          x-versionadded: v2.33
      required:
      - columnCount
      - connectionName
      - dataSourceId
      - dataStoreId
      - inputType
      - name
      - rowCount
      - status
      type: object
    RecipeInputsResponse:
      properties:
        inputs:
          description: List of recipe inputs
          items:
            $ref: '#/components/schemas/RecipeInputStatsResponse'
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - inputs
      type: object
    RecipePreviewResponse:
      properties:
        byteSize:
          description: Data memory usage
          minimum: 0
          type: integer
          x-versionadded: v2.33
        columns:
          description: List of columns in data preview
          items:
            description: Column name
            type: string
          maxItems: 10000
          type: array
          x-versionadded: v2.33
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of records output by the query.
          items:
            description: List of values for a single database record, ordered as the
              columns are ordered.
            items:
              description: String representation of the column's value.
              type: string
            maxItems: 10000
            type: array
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        estimatedSizeExceedsLimit:
          description: Defines if downsampling should be done based on sample size
          type: boolean
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        resultSchema:
          description: JDBC result schema
          items:
            $ref: '#/components/schemas/DataStoreExtendedColumnNoKeysResponse'
            description: JDBC result column description
          maxItems: 10000
          nullable: true
          type: array
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - byteSize
      - columns
      - data
      - estimatedSizeExceedsLimit
      - next
      - previous
      - resultSchema
      - totalCount
      type: object
    RecipeResponse:
      properties:
        createdAt:
          description: ISO 8601-formatted date/time when the recipe was created.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: The ID of the user that created the recipe.
          nullable: true
          x-versionadded: v2.33
        description:
          description: The recipe description.
          maxLength: 1000
          type: string
          x-versionadded: v2.33
        dialect:
          description: Source type data was retrieved from.
          enum:
          - snowflake
          - bigquery
          - spark-feature-discovery
          - databricks
          - spark
          type: string
          x-versionadded: v2.33
        downsampling:
          $ref: '#/components/schemas/OneOfDownsamplingDirective'
          description: Data transformation step.
          nullable: true
          x-versionadded: v2.33
        inputs:
          description: List of data sources.
          items:
            $ref: '#/components/schemas/RecipeInputResponse'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        name:
          description: The recipe name.
          maxLength: 255
          nullable: true
          type: string
          x-versionadded: v2.33
        operations:
          description: List of transformations
          items:
            $ref: '#/components/schemas/OneOfDirective'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        recipeId:
          description: The ID of the recipe.
          type: string
          x-versionadded: v2.33
        recipeType:
          description: Type of the recipe workflow.
          enum:
          - wrangling
          - Wrangling
          - WRANGLING
          - featureDiscovery
          - FeatureDiscovery
          - FEATURE_DISCOVERY
          - featureDiscoveryPrivatePreview
          - FeatureDiscoveryPrivatePreview
          - FEATURE_DISCOVERY_PRIVATE_PREVIEW
          type: string
          x-versionadded: v2.33
        settings:
          $ref: '#/components/schemas/RecipeSettingsResponse'
          description: Recipe settings reusable at a modeling stage.
          x-versionadded: v2.33
        status:
          description: Recipe publication status.
          enum:
          - draft
          - preview
          - published
          type: string
          x-versionadded: v2.33
        updatedAt:
          description: ISO 8601-formatted date/time when the recipe was last updated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: The ID of the last user that updated the recipe.
          nullable: true
          x-versionadded: v2.33
      required:
      - createdAt
      - createdBy
      - description
      - dialect
      - downsampling
      - inputs
      - name
      - operations
      - recipeId
      - recipeType
      - settings
      - status
      - updatedAt
      - updatedBy
      type: object
    RecipeSettingsResponse:
      properties:
        featureDiscoveryProjectId:
          description: Associated feature discovery project ID.
          nullable: true
          type: string
          x-versionadded: v2.33
        predictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          maxLength: 255
          nullable: true
          type: string
          x-versionadded: v2.33
        relationshipsConfigurationId:
          description: Associated relationships configuration ID.
          nullable: true
          type: string
          x-versionadded: v2.33
        target:
          description: The feature to use as the target at the modeling stage.
          nullable: true
          type: string
          x-versionadded: v2.33
        weightsFeature:
          description: The weights feature.
          nullable: true
          type: string
          x-versionadded: v2.33
      required:
      - featureDiscoveryProjectId
      - predictionPoint
      - relationshipsConfigurationId
      type: object
    RecipeSettingsUpdate:
      properties:
        predictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          maxLength: 255
          nullable: true
          type: string
          x-versionadded: v2.33
        relationshipsConfigurationId:
          description: The associated relationships configuration ID.
          nullable: true
          type: string
          x-versionadded: v2.33
        target:
          description: The feature to use as the target at the modeling stage.
          nullable: true
          type: string
          x-versionadded: v2.33
        weightsFeature:
          description: The weights feature.
          nullable: true
          type: string
          x-versionadded: v2.33
      type: object
    RecipesListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: A list of the datasets in this Use Case.
          items:
            $ref: '#/components/schemas/RecipeResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RecommendedModelResponse:
      properties:
        modelId:
          description: the ID of the recommended model
          type: string
        recommendationType:
          description: the type of model recommendation
          enum:
          - MOSTACCURATE
          - LIMITEDACCURATE
          - FASTACCURATE
          - RECOMMENDEDFORDEPLOYMENT
          - PREPAREDFORDEPLOYMENT
          type: string
      required:
      - modelId
      - recommendationType
      type: object
    RefinexInsightsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: The list of features related to the requested dataset.
          items:
            $ref: '#/components/schemas/WranglingFeatureResponse'
          maxItems: 100
          type: array
          x-versionadded: v2.33
        message:
          description: Status message.
          type: string
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        status:
          description: Job status.
          enum:
          - ABORTED
          - COMPLETED
          - ERROR
          - EXPIRED
          - INITIALIZED
          - RUNNING
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RegisteredModelCreatedBy:
      properties:
        email:
          description: Email of the user that created the registered model
          type: string
        id:
          description: ID of user that created the registered model
          type: string
        name:
          description: Full name of the user that created the registered model
          nullable: true
          type: string
      required:
      - email
      - id
      - name
      type: object
    RegisteredModelDeploymentResponse:
      properties:
        createdAt:
          description: Deployment creation date
          type: string
        createdBy:
          $ref: '#/components/schemas/UserMetadata'
          description: Information on the creator of the deployment
          nullable: true
        currentlyDeployed:
          description: Whether version of this registered model is currently deployed
          type: boolean
        firstDeployedAt:
          description: When version of this registered model was first deployed
          nullable: true
          type: string
        firstDeployedBy:
          $ref: '#/components/schemas/UserMetadata'
          description: Information on the user who first deployed the version of this
            registered model
          nullable: true
        id:
          description: ID of the deployment
          type: string
        isChallenger:
          description: True if given version is a challenger in a given deployment
          type: boolean
        label:
          description: Label of the deployment
          nullable: true
          type: string
        predictionEnvironment:
          $ref: '#/components/schemas/DeploymentPredictionEnvironmentResponse'
          description: Information related to the current PredictionEnvironment.
          nullable: true
        registeredModelVersion:
          description: Version of the registered model
          type: integer
        status:
          description: Status of the deployment
          type: string
      required:
      - createdAt
      - createdBy
      - currentlyDeployed
      - firstDeployedAt
      - firstDeployedBy
      - id
      - isChallenger
      - label
      - registeredModelVersion
      - status
      type: object
    RegisteredModelDeploymentsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of formatted deployments
          items:
            $ref: '#/components/schemas/RegisteredModelDeploymentResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RegisteredModelListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of formatted registered models
          items:
            $ref: '#/components/schemas/RegisteredModelResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RegisteredModelResponse:
      properties:
        createdAt:
          description: Date when the registered model was created
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/RegisteredModelCreatedBy'
          description: Information on the creator of the registered model
        description:
          description: Description of the registered model
          nullable: true
          type: string
        id:
          description: ID of the registered model
          type: string
        isArchived:
          description: Whether the model is archived
          type: boolean
        isGlobal:
          description: Whether the registered model is global (accessible to all users
            in the organization) or local(accessible only to the owner and the users
            with whom it has been explicitly shared)
          type: boolean
        lastVersionNum:
          description: Latest version associated to this registered model
          type: integer
        modifiedAt:
          description: Date when the registered model was last modified
          format: date-time
          type: string
        modifiedBy:
          $ref: '#/components/schemas/UserMetadata'
          description: Information on the user who last modified the registered model
          nullable: true
        name:
          description: Name of the registered model
          type: string
        target:
          $ref: '#/components/schemas/RegisteredModelTarget'
          description: Information on the target variable
      required:
      - createdAt
      - createdBy
      - id
      - isArchived
      - lastVersionNum
      - modifiedAt
      - modifiedBy
      - name
      - target
      type: object
    RegisteredModelTarget:
      properties:
        name:
          description: Name of the target variable
          type: string
        type:
          description: Type of the target variable
          nullable: true
          type: string
      required:
      - name
      - type
      type: object
    RegisteredModelUpdate:
      properties:
        description:
          description: Description of the registered model
          maxLength: 2048
          type: string
        isGlobal:
          description: Make registered model global (accessible to all users in the
            organization) or local(accessible only to the owner and the users with
            whom it has been explicitly shared)
          type: boolean
        name:
          description: Name of the registered model
          maxLength: 1024
          type: string
      type: object
    RegisteredModelVersionsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of formatted registered model's versions
          items:
            $ref: '#/components/schemas/ModelPackageRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    Relationship:
      properties:
        dataset1Identifier:
          description: Identifier of the first dataset in the relationship. If this
            is not provided, it represents the primary dataset.
          maxLength: 20
          minLength: 1
          nullable: true
          type: string
        dataset1Keys:
          description: column(s) in the first dataset that are used to join to the
            second dataset.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        dataset2Identifier:
          description: Identifier of the second dataset in the relationship.
          maxLength: 20
          minLength: 1
          type: string
        dataset2Keys:
          description: column(s) in the second dataset that are used to join to the
            first dataset.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        featureDerivationWindowEnd:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should end. Will be a non-positive integer,
            if present. If present, time-aware joins will be used. Only applicable
            when table1Identifier is not provided.
          maximum: 0
          type: integer
        featureDerivationWindowStart:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should begin. Will be a negative integer, if
            present. If present, time-aware joins will be used. Only applicable when
            table1Identifier is not provided.
          exclusiveMaximum: true
          maximum: 0
          type: integer
        featureDerivationWindowTimeUnit:
          description: Time unit of the feature derivation window. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
            If present, time-aware joins will be used. Only applicable when table1Identifier
            is not provided.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type: string
        featureDerivationWindows:
          description: List of feature derivation window definitions that will be
            used.
          items:
            $ref: '#/components/schemas/FeatureDerivationWindow'
          type: array
          x-versionadded: '2.27'
        predictionPointRounding:
          description: Closest value of predictionPointRoundingTimeUnit to round the
            prediction point into the past when applying the feature derivation window.
            Will be a positive integer, if present. Only applicable when table1Identifier
            is not provided.
          exclusiveMinimum: true
          maximum: 30
          minimum: 0
          type: integer
        predictionPointRoundingTimeUnit:
          description: Time unit of the prediction point rounding. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
            Only applicable when table1Identifier is not provided.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type: string
      required:
      - dataset1Keys
      - dataset2Identifier
      - dataset2Keys
      type: object
    RelationshipQualityAssessmentsCreate:
      properties:
        credentials:
          description: Credentials for dynamic policy secondary datasets.
          items:
            oneOf:
            - $ref: '#/components/schemas/StoredCredentials'
            - $ref: '#/components/schemas/CatalogPasswordCredentials'
          nullable: true
          type: array
        datetimePartitionColumn:
          description: If a datetime partition column was used, the name of the column.
          nullable: true
          type: string
        featureEngineeringPredictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          nullable: true
          type: string
        relationshipsConfiguration:
          $ref: '#/components/schemas/RelationshipsConfigPayload'
          description: Object describing how secondary datasets are related to the
            primary dataset
        userId:
          description: Mongo Id of the User who created the request
          type: string
      required:
      - relationshipsConfiguration
      type: object
    RelationshipQualitySummary:
      properties:
        enrichmentRate:
          description: Percentage of records that can be enriched with a record in
            the primary table
          type: number
        formattedSummary:
          $ref: '#/components/schemas/FormattedSummary'
          description: Relationship quality assessment report associated with the
            relationship
        lastUpdated:
          description: Last updated timestamp
          format: date-time
          type: string
        overallCategory:
          description: Class of the relationship quality
          enum:
          - green
          - yellow
          type: string
        status:
          description: Relationship quality assessment status
          enum:
          - Complete
          - In progress
          - Error
          type: string
        statusId:
          description: List of status Ids
          items:
            type: string
          maxItems: 3
          minItems: 1
          type: array
      required:
      - enrichmentRate
      - formattedSummary
      - lastUpdated
      - overallCategory
      type: object
    RelationshipQualitySummaryNewFormat:
      properties:
        detailedReport:
          description: Detailed report of the relationship quality information
          items:
            $ref: '#/components/schemas/AssessmentNewFormat'
          maxItems: 3
          type: array
        lastUpdated:
          description: Last updated timestamp
          format: date-time
          type: string
        problemCount:
          description: Total count of problems detected
          type: integer
        samplingFraction:
          description: Primary dataset sampling fraction used for relationship quality
            assessment speedup
          type: number
        status:
          description: Relationship quality assessment status
          enum:
          - Complete
          - In progress
          - Error
          type: string
        statusId:
          description: List of status Ids
          items:
            type: string
          maxItems: 3
          minItems: 1
          type: array
        summaryCategory:
          description: Class of the summary warning of the relationship
          enum:
          - green
          - yellow
          type: string
        summaryMessage:
          description: Summary warning message about the relationship
          type: string
      required:
      - detailedReport
      - lastUpdated
      - problemCount
      - samplingFraction
      - summaryCategory
      - summaryMessage
      type: object
    RelationshipResponse:
      properties:
        dataset1Identifier:
          description: Identifier of the first dataset in the relationship. If this
            is not provided, it represents the primary dataset.
          maxLength: 20
          minLength: 1
          nullable: true
          type: string
        dataset1Keys:
          description: column(s) in the first dataset that are used to join to the
            second dataset.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        dataset2Identifier:
          description: Identifier of the second dataset in the relationship.
          maxLength: 20
          minLength: 1
          type: string
        dataset2Keys:
          description: column(s) in the second dataset that are used to join to the
            first dataset.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        featureDerivationWindowEnd:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should end. Will be a non-positive integer,
            if present. If present, time-aware joins will be used.
          maximum: 0
          nullable: true
          type: integer
        featureDerivationWindowStart:
          description: How many featureDerivationWindowUnits of each dataset's primary
            temporal key into the past relative to the datetimePartitionColumn the
            feature derivation window should begin. Will be a negative integer, if
            present. If present, time-aware joins will be used.
          exclusiveMaximum: true
          maximum: 0
          nullable: true
          type: integer
        featureDerivationWindowTimeUnit:
          description: Time unit of the feature derivation window. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
            If present, time-aware joins will be used.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          nullable: true
          type: string
        featureDerivationWindows:
          description: List of feature derivation window definitions that will be
            used.
          items:
            $ref: '#/components/schemas/FeatureDerivationWindow'
          type: array
          x-versionadded: '2.27'
        predictionPointRounding:
          description: Can be null, closest value of predictionPointRoundingTimeUnit
            to round the prediction point into the past when applying the feature
            derivation window. Will be a positive integer, if present.
          exclusiveMinimum: true
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
        predictionPointRoundingTimeUnit:
          description: Time unit of the prediction point rounding. Supported values
            are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.
          enum:
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          nullable: true
          type: string
      required:
      - dataset1Identifier
      - dataset1Keys
      - dataset2Identifier
      - dataset2Keys
      type: object
    RelationshipsConfigCreate:
      properties:
        datasetDefinitions:
          description: List of dataset definitions.
          items:
            $ref: '#/components/schemas/DatasetDefinition'
          type: array
        featureDiscoveryMode:
          description: Mode of feature discovery. Supported values are 'default' and
            'manual'.
          enum:
          - default
          - manual
          type: string
        featureDiscoverySettings:
          description: List of feature discovery settings used to customize the feature
            discovery process. Applicable when feature_discovery_mode is 'manual'.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySetting'
          type: array
        relationships:
          description: List of relationship between datasets specified in datasetDefinitions.
          items:
            $ref: '#/components/schemas/Relationship'
          type: array
      required:
      - datasetDefinitions
      - relationships
      type: object
    RelationshipsConfigPayload:
      properties:
        datasetDefinitions:
          description: A list of datasets
          items:
            $ref: '#/components/schemas/DatasetDefinition'
          minItems: 1
          type: array
        featureDiscoveryMode:
          description: Mode of feature discovery. Supported values are 'default' and
            'manual'.
          enum:
          - default
          - manual
          nullable: true
          type: string
        featureDiscoverySettings:
          description: List of feature discovery settings used to customize the feature
            discovery process.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySettingResponse'
          nullable: true
          type: array
        id:
          description: Id of the relationship configuration
          type: string
        relationships:
          description: A list of relationships
          items:
            $ref: '#/components/schemas/Relationship'
          minItems: 1
          type: array
        snowflakePushDownCompatible:
          description: Flag indicating if the relationships configuration is compatible
            with Snowflake push down processing.
          nullable: true
          type: boolean
      required:
      - datasetDefinitions
      - id
      - relationships
      type: object
    RelationshipsConfigResponse:
      properties:
        datasetDefinitions:
          description: List of dataset definitions.
          items:
            $ref: '#/components/schemas/DatasetDefinitionResponse'
          type: array
        featureDiscoveryMode:
          description: Mode of feature discovery. Supported values are 'default' and
            'manual'.
          enum:
          - default
          - manual
          nullable: true
          type: string
        featureDiscoverySettings:
          description: List of feature discovery settings used to customize the feature
            discovery process.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySettingResponse'
          nullable: true
          type: array
        id:
          description: ID of relationships configuration.
          type: string
        relationships:
          description: List of relationship between datasets specified in datasetDefinitions.
          items:
            $ref: '#/components/schemas/RelationshipResponse'
          type: array
        snowflakePushDownCompatible:
          description: Is this configuration compatible with pushdown computation
            on Snowflake?
          nullable: true
          type: boolean
      required:
      - datasetDefinitions
      - relationships
      type: object
    RemoteEventCreate:
      properties:
        data:
          $ref: '#/components/schemas/RemoteEventData'
          description: Event payload.
        deploymentId:
          description: The identifier of the deployment associated with the event.
          type: string
        eventType:
          description: The type of the event. Labels in all_lower_case are deprecated.
          enum:
          - deploymentInfo
          - externalNaNPredictions
          - management.deploymentInfo
          - model_deployments.accuracy_green
          - model_deployments.accuracy_red
          - model_deployments.accuracy_yellow_from_green
          - model_deployments.data_drift_green
          - model_deployments.data_drift_red
          - model_deployments.data_drift_yellow_from_green
          - model_deployments.model_replacement
          - model_deployments.service_health_green
          - model_deployments.service_health_red
          - model_deployments.service_health_yellow_from_green
          - monitoring.external_model_nan_predictions
          - monitoring.spooler_channel_green
          - monitoring.spooler_channel_red
          - predictionRequestFailed
          - prediction_request.failed
          - serviceHealthChangeGreen
          - serviceHealthChangeRed
          - serviceHealthChangeYellowFromGreen
          - spoolerChannelGreen
          - spoolerChannelRed
          type: string
        externalNanPredictionsData:
          $ref: '#/components/schemas/ExternalNaNPredictionsEventData'
          description: External NaN Predictions event payload
        message:
          description: Descriptive message for health events.
          maxLength: 16384
          type: string
        orgId:
          description: The identifier of the organization associated with the event.
          nullable: true
          type: string
        predictionEnvironmentId:
          description: The identifier of the prediction environment associated with
            the event.
          type: string
        predictionRequestData:
          $ref: '#/components/schemas/PredictionRemoteEventData'
          description: Prediction event payload.
        spoolerChannelData:
          $ref: '#/components/schemas/SpoolerChannelEventData'
          description: Spooler channel event payload.
        timestamp:
          description: The time when the event occurred.
          format: date-time
          type: string
        title:
          description: The title of the event.
          maxLength: 512
          type: string
      required:
      - eventType
      - timestamp
      type: object
    RemoteEventData:
      properties:
        newModelId:
          description: The identifier of the model after replacement.
          type: string
        oldModelId:
          description: The identifier of the model before replacement.
          type: string
        reason:
          description: The explanation on why the model has been replaced.
          type: string
      type: object
    RenameColumn:
      properties:
        newName:
          description: The new column name.
          type: string
          x-versionadded: v2.33
        originalName:
          description: The original column name.
          type: string
          x-versionadded: v2.33
      required:
      - newName
      - originalName
      type: object
    RenameColumnsArguments:
      properties:
        columnMappings:
          description: The list of name mappings.
          items:
            $ref: '#/components/schemas/RenameColumn'
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - columnMappings
      type: object
    ReplaceDirectiveArguments:
      properties:
        isCaseSensitive:
          default: true
          description: The flag indicating if the "search_for" value is case-sensitive.
          type: boolean
          x-versionadded: v2.33
        matchMode:
          description: The match mode to use when detecting "search_for" values.
          enum:
          - partial
          - exact
          - regex
          type: string
          x-versionadded: v2.33
        origin:
          description: The place name to look for in values.
          type: string
          x-versionadded: v2.33
        replacement:
          default: ''
          description: The replacement value.
          type: string
          x-versionadded: v2.33
        searchFor:
          description: Indicates what needs to be replaced.
          type: string
          x-versionadded: v2.33
      required:
      - matchMode
      - origin
      - searchFor
      type: object
    RequestNotification:
      properties:
        body:
          description: The body of the request
          type: string
        headers:
          description: The headers of the request
          type: string
        url:
          description: The URL of the request
          format: uri
          nullable: true
          type: string
      required:
      - body
      - headers
      - url
      type: object
    RequiredMetadataValue:
      properties:
        fieldName:
          description: The required field name. This value will be added as an environment
            variable when running custom models.
          type: string
        value:
          description: The value for the given field.
          maxLength: 100
          type: string
      required:
      - fieldName
      - value
      type: object
    ResidualsChartForDatasets:
      properties:
        coefficientOfDetermination:
          description: Also known as the r-squared value. This value is calculated
            over the downsampled dataset, not the full input.
          type: number
        data:
          description: The rows of chart data in [actual, predicted, residual, row
            number] form.  If the row number was not available at the time of model
            creation, the row number will be `null`.
          items:
            items:
              type: number
            type: array
          type: array
        datasetId:
          description: The dataset ID.
          type: string
        histogram:
          description: Data to plot a histogram of residual values. The object contains
            three keys, intervalStart, intervalEnd, and occurrences, the number of
            times the predicted value fits within that interval. For all but the last
            interval, the end value is exclusive.
          items:
            $ref: '#/components/schemas/Histogram'
          type: array
        residualMean:
          description: The arithmetic mean of the predicted value minus the actual
            value over the downsampled dataset.
          type: number
        standardDeviation:
          description: The Standard Deviation value measures variation in the dataset.
            A low value indicates that the data points tend to be close to the mean;
            a high value indicates that the data points are spread over a wider range
            of values.
          type: number
      required:
      - coefficientOfDetermination
      - data
      - datasetId
      - histogram
      - residualMean
      - standardDeviation
      type: object
    ResidualsChartForDatasetsList:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of residuals charts for dataset.
          items:
            $ref: '#/components/schemas/ResidualsChartForDatasets'
          type: array
        modelId:
          description: The model ID.
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        projectId:
          description: The project ID.
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - modelId
      - next
      - previous
      - projectId
      - totalCount
      type: object
    ResourceUsage:
      properties:
        currentUsage:
          description: The usage accumulated within the current window.
          type: integer
        maxUsage:
          description: The maximum value currentUsage can take before requests using
            this resource are denied.
          type: integer
        resource:
          description: The rate limit resource this usage applies to.
          type: string
        timeToExpire:
          description: The number of seconds until this usage resets to zero.
          type: integer
      required:
      - currentUsage
      - maxUsage
      - resource
      - timeToExpire
      type: object
    ResourceUsageResponse:
      properties:
        count:
          description: The number of resource usage records.
          type: integer
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
        usage:
          description: The resource usage records.
          items:
            $ref: '#/components/schemas/ResourceUsage'
          type: array
      required:
      - count
      - next
      - previous
      - usage
      type: object
    ResponseNotification:
      properties:
        body:
          description: The body of the response
          type: string
        duration:
          description: The duration
          type: integer
        headers:
          description: The headers of the response
          type: string
        statusCode:
          description: The status code of the response
          type: string
      required:
      - body
      - duration
      - headers
      - statusCode
      type: object
    RetrainDatetimeModel:
      properties:
        featurelistId:
          description: If specified, the new model will be trained using this featurelist.
            Otherwise, the model will be trained on the same feature list as the source
            model.
          type: string
        modelId:
          description: The ID of an existing model to use as the source for the training
            parameters.
          type: string
        monotonicDecreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If ``null``,
            no such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.23
        monotonicIncreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If ``null``,
            no such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.23
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          maximum: 100
          minimum: 2
          type: integer
          x-versionadded: v2.27
        samplingMethod:
          description: Defines how training data is selected if subsampling is used
            (e.g., if `timeWindowSamplePct` is specified). Can be either ``random``
            or ``latest``. If omitted, defaults to ``latest`` if `trainingRowCount`
            is used and ``random`` for other cases (e.g., if `trainingDuration` or
            `useProjectSettings` is specified). May only be specified for OTV projects.
          enum:
          - random
          - latest
          type: string
          x-versionadded: v2.20
        timeWindowSamplePct:
          description: An integer between 1 and 99 indicating the percentage of sampling
            within the time window. The points kept are determined by the value provided
            for the `samplingMethod` option. If specified, `trainingRowCount` may
            not be specified, and the specified model must either be a duration or
            selectedDateRange model, or one of `trainingDuration` or `trainingStartDate`
            and `trainingEndDate` must be specified.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
        trainingDuration:
          description: A duration string representing the training duration to use
            for training the new model. If specified, the model will be trained using
            the specified training duration. Otherwise, the original model's duration
            will be used. Only one of `trainingRowCount`, `trainingDuration`, `trainingStartDate`
            and `trainingEndDate`, or `useProjectSettings` may be specified.
          format: duration
          type: string
        trainingEndDate:
          description: A datetime string representing the end date of the data to
            use for training this model. Note that only one of `trainingDuration`
            or `trainingRowCount` or `trainingStartDate` and `trainingEndDate` should
            be specified. If `trainingStartDate` and `trainingEndDate` are specified,
            the source model must be frozen.
          format: date-time
          type: string
        trainingRowCount:
          description: The number of rows of data that should be used to train the
            model. If not specified, the original model's row count will be used.
            Only one of `trainingRowCount`, `trainingDuration`, `trainingStartDate`
            and `trainingEndDate`, or `useProjectSettings` may be specified.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        trainingStartDate:
          description: A datetime string representing the start date of the data to
            use for training this model. Note that only one of `trainingDuration`
            or `trainingRowCount` or `trainingStartDate` and `trainingEndDate` should
            be specified. If `trainingStartDate` and `trainingEndDate` are specified,
            the source model must be frozen.
          format: date-time
          type: string
        useProjectSettings:
          description: If ``True``, the model will be trained using the previously-specified
            custom backtest training settings. Only one of `trainingRowCount`, `trainingDuration`,
            `trainingStartDate` and `trainingEndDate`, or `useProjectSettings` may
            be specified.
          type: boolean
          x-versionadded: v2.24
      required:
      - modelId
      type: object
    RetrainModel:
      properties:
        featurelistId:
          description: If specified, the model will be trained using that featurelist,
            otherwise the model will be trained on the same feature list as before.
          type: string
        modelId:
          description: The model to be retrained
          type: string
        monotonicDecreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.23
        monotonicIncreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If null, no
            such constraints are enforced.
          nullable: true
          type: string
          x-versionadded: v2.23
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          maximum: 100
          minimum: 2
          type: integer
          x-versionadded: v2.27
        samplePct:
          description: The percentage of the dataset to use to use to train the model.
            The specified percentage should be between 0 and 100. If not specified,
            original model sample percent will be used.
          type: number
        scoringType:
          description: Validation is available for any partitioning. If the project
            uses cross validation, `crossValidation` may be used to indicate that
            all available training/validation combinations should be used.
          enum:
          - validation
          - crossValidation
          type: string
          x-versionadded: v2.23
        trainingRowCount:
          description: The number of rows to use to train the model. If not specified,
            original model training row count will be used.
          type: integer
      required:
      - modelId
      type: object
    RetrainingPolicyCreate:
      properties:
        action:
          description: Configure the action to take on the resultant new model.
          enum:
          - create_challenger
          - create_model_package
          - model_replacement
          type: string
        autopilotOptions:
          $ref: '#/components/schemas/AutopilotOptions'
          description: Will override the corresponding fields when reusing champion's
            project options.
        description:
          default: null
          description: Description of the retraining policy.
          maxLength: 10000
          nullable: true
          type: string
        featureListStrategy:
          description: Configure the feature list strategy used for modeling.
          enum:
          - informative_features
          - same_as_champion
          type: string
        modelSelectionStrategy:
          description: Configure how new model is selected when the retraining policy
            runs.
          enum:
          - autopilot_recommended
          - same_blueprint
          - same_hyperparameters
          type: string
        name:
          description: Name of the retraining policy.
          maxLength: 512
          type: string
        projectOptions:
          $ref: '#/components/schemas/ProjectOptions'
          description: Options for projects used to build new models.
        projectOptionsStrategy:
          description: Configure the project option strategy used for modeling.
          enum:
          - same_as_champion
          - override_champion
          - custom
          type: string
        timeSeriesOptions:
          $ref: '#/components/schemas/TimeSeriesOptions'
          description: Time Series project option used to build new models.
        trigger:
          $ref: '#/components/schemas/Trigger'
          description: Retraining policy trigger.
      required:
      - description
      - name
      type: object
    RetrainingPolicyListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of retraining policies.
          items:
            $ref: '#/components/schemas/RetrainingPolicyRetrieve'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrainingPolicyRetrieve:
      properties:
        action:
          description: Configure the action to take on the resultant new model.
          enum:
          - create_challenger
          - create_model_package
          - model_replacement
          type: string
        autopilotOptions:
          $ref: '#/components/schemas/AutopilotOptions'
          description: Options for projects used to build new models.
        description:
          description: Description of the retraining policy.
          nullable: true
          type: string
        featureListStrategy:
          description: Configure the feature list strategy used for modeling.
          enum:
          - informative_features
          - same_as_champion
          type: string
        id:
          description: ID of the retraining policy.
          type: string
        latestRun:
          $ref: '#/components/schemas/RetrainingPolicyRunRetrieve'
          description: Latest run of the retraining policy.
          nullable: true
        modelSelectionStrategy:
          description: Configure how new model is selected when the retraining policy
            runs.
          enum:
          - autopilot_recommended
          - same_blueprint
          - same_hyperparameters
          type: string
        name:
          description: Name of the retraining policy.
          type: string
        projectOptions:
          $ref: '#/components/schemas/ProjectOptions'
          description: Options for projects used to build new models.
        projectOptionsStrategy:
          description: Configure the project option strategy used for modeling.
          enum:
          - same_as_champion
          - override_champion
          - custom
          type: string
        timeSeriesOptions:
          $ref: '#/components/schemas/TimeSeriesOptions'
          description: Time Series project option used to build new models.
        trigger:
          $ref: '#/components/schemas/Trigger'
          description: Retraining policy trigger.
      required:
      - action
      - autopilotOptions
      - description
      - id
      - latestRun
      - modelSelectionStrategy
      - name
      - projectOptions
      - trigger
      type: object
    RetrainingPolicyRunListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of retraining policy runs.
          items:
            $ref: '#/components/schemas/RetrainingPolicyRunRetrieve'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrainingPolicyRunRetrieve:
      properties:
        challengerId:
          description: ID of the challenger created from this retraining policy run.
          nullable: true
          type: string
        errorMessage:
          description: Error message of the retraining policy run.
          nullable: true
          type: string
        finishTime:
          description: Finish time of the retraining policy run.
          format: date-time
          nullable: true
          type: string
        id:
          description: ID of the retraining policy run.
          type: string
        modelPackageId:
          description: ID of the model package created from this retraining policy
            run.
          nullable: true
          type: string
        projectId:
          description: ID of the project created from this retraining policy run.
          nullable: true
          type: string
        registeredModelId:
          description: ID of the registered model associated with model package created
            from this retraining policy run
          nullable: true
          type: string
        startTime:
          description: Start time of the retraining policy run.
          format: date-time
          nullable: true
          type: string
        status:
          description: Status of the retraining policy run.
          nullable: true
          type: string
      required:
      - challengerId
      - errorMessage
      - finishTime
      - id
      - modelPackageId
      - projectId
      - registeredModelId
      - startTime
      - status
      type: object
    RetrainingPolicyRunUpdate:
      properties:
        status:
          description: New status of the retraining policy.
          enum:
          - cancelled
          type: string
      required:
      - status
      type: object
    RetrainingPolicyUpdate:
      properties:
        action:
          description: Configure the action to take on the resultant new model.
          enum:
          - create_challenger
          - create_model_package
          - model_replacement
          type: string
        autopilotOptions:
          $ref: '#/components/schemas/AutopilotOptions'
          description: Options for projects used to build new models.
        description:
          description: Description of the retraining policy.
          maxLength: 10000
          nullable: true
          type: string
        featureListStrategy:
          description: Configure the feature list strategy used for modeling.
          enum:
          - informative_features
          - same_as_champion
          type: string
        modelSelectionStrategy:
          description: Configure how new model is selected when the retraining policy
            runs.
          enum:
          - autopilot_recommended
          - same_blueprint
          - same_hyperparameters
          type: string
        name:
          description: Name of the retraining policy.
          maxLength: 512
          type: string
        projectOptions:
          $ref: '#/components/schemas/ProjectOptions'
          description: Options for projects used to build new models.
        projectOptionsStrategy:
          description: Configure the project option strategy used for modeling.
          enum:
          - same_as_champion
          - override_champion
          - custom
          type: string
        timeSeriesOptions:
          $ref: '#/components/schemas/TimeSeriesOptions'
          description: Time Series project option used to build new models.
        trigger:
          $ref: '#/components/schemas/Trigger'
          description: Retraining policy trigger.
      type: object
    RetrainingSettingsRetrieve:
      properties:
        dataset:
          $ref: '#/components/schemas/Dataset'
          description: The dataset that will be used as retraining data.
          nullable: true
        predictionEnvironment:
          $ref: '#/components/schemas/PredictionEnvironment'
          description: The prediction environment that will be associated with the
            challengers created by retraining policies.
          nullable: true
        retrainingUser:
          $ref: '#/components/schemas/RetrainingUser'
          description: The user scheduled retraining will be performed on behalf of.
          nullable: true
      required:
      - dataset
      - predictionEnvironment
      - retrainingUser
      type: object
    RetrainingSettingsUpdate:
      properties:
        credentialId:
          description: ID of the credential used to refresh retraining dataset.
          nullable: true
          type: string
        datasetId:
          description: ID of the retraining dataset.
          nullable: true
          type: string
        predictionEnvironmentId:
          description: ID of the prediction environment to associate with the challengers
            created by retraining policies.
          nullable: true
          type: string
        retrainingUserId:
          description: ID of the retraining user.
          type: string
      type: object
    RetrainingUser:
      properties:
        id:
          description: ID of the scheduled retraining user.
          type: string
        username:
          description: Username of the scheduled retraining user.
          type: string
      required:
      - id
      - username
      type: object
    RetrieveCredentialAssociationResponse:
      properties:
        creationDate:
          description: ISO-8601 formatted date/time when these credentials were created.
          format: date-time
          type: string
        credentialId:
          description: ID of these credentials.
          type: string
        credentialType:
          default: basic
          description: Type of credentials.
          enum:
          - adls_gen2_oauth
          - api_token
          - azure
          - azure_service_principal
          - basic
          - bearer
          - databricks_access_token_account
          - databricks_service_principal_account
          - gcp
          - oauth
          - rsa
          - s3
          - snowflake_key_pair_user_account
          - snowflake_oauth_user_account
          - tableau_access_token
          type: string
        description:
          description: Description of these credentials.
          type: string
        isDefault:
          description: Whether this credential association with the given object is
            default for given session user.
          type: boolean
        name:
          description: Name of these credentials.
          type: string
        objectId:
          description: Associated object ID.
          type: string
        objectType:
          description: Associated object type.
          enum:
          - batchPredictionJobDefinition
          - dataconnection
          type: string
      required:
      - creationDate
      - credentialId
      - name
      - objectId
      - objectType
      type: object
    RetrieveDataEngineQueryResponse:
      properties:
        datasets:
          description: Source datasets in the Data Engine workspace.
          items:
            $ref: '#/components/schemas/DataEngineDataset'
          maxItems: 32
          type: array
        generatorSettings:
          $ref: '#/components/schemas/GeneratorSettings'
          description: Data engine generator settings of the given `generator_type`.
        generatorType:
          description: Type of data engine query generator
          enum:
          - TimeSeries
          type: string
        id:
          description: The ID of the data engine query generator.
          type: string
        query:
          description: Generated SparkSQL query.
          type: string
      required:
      - datasets
      - generatorSettings
      - generatorType
      - id
      - query
      type: object
    RetrieveFeatureEffectsIndividualResponse:
      properties:
        backtestIndex:
          description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`.'
          type: string
        data:
          $ref: '#/components/schemas/FeatureEffectsInsightResponse'
          description: Feature effects data.
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
        entityId:
          description: ID of the model.
          type: string
        id:
          description: ID of the created insight.
          type: string
        projectId:
          description: ID of the project.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - training
          - backtest_0
          - backtest_1
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          - holdout
          - backtest_0_training
          - backtest_1_training
          - backtest_2_training
          - backtest_3_training
          - backtest_4_training
          - backtest_5_training
          - backtest_6_training
          - backtest_7_training
          - backtest_8_training
          - backtest_9_training
          - backtest_10_training
          - backtest_11_training
          - backtest_12_training
          - backtest_13_training
          - backtest_14_training
          - backtest_15_training
          - backtest_16_training
          - backtest_17_training
          - backtest_18_training
          - backtest_19_training
          - backtest_20_training
          - holdout_training
          type: string
      required:
      - data
      - id
      type: object
    RetrieveFeatureEffectsPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of paginated feature effects insights.
          items:
            $ref: '#/components/schemas/RetrieveFeatureEffectsIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveFeatureImpactIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/FeatureImpactInsightResponse'
          description: Feature impact data.
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
        entityId:
          description: ID of the model.
          type: string
        id:
          description: ID of the created insight.
          type: string
        projectId:
          description: ID of the project.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - training
          - backtest_2Training
          - backtest_3Training
          - backtest_4Training
          - backtest_5Training
          - backtest_6Training
          - backtest_7Training
          - backtest_8Training
          - backtest_9Training
          - backtest_10Training
          - backtest_11Training
          - backtest_12Training
          - backtest_13Training
          - backtest_14Training
          - backtest_15Training
          - backtest_16Training
          - backtest_17Training
          - backtest_18Training
          - backtest_19Training
          - backtest_20Training
          - backtest_1Training
          - holdoutTraining
          type: string
      required:
      - data
      - id
      type: object
    RetrieveFeatureImpactPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of paginated feature impact insights.
          items:
            $ref: '#/components/schemas/RetrieveFeatureImpactIndividualResponse'
          maxItems: 2
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveLiftChartIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/LiftChartResponse'
          description: Lift chart data.
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
        entityId:
          description: ID of the model.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          nullable: true
          type: string
        id:
          description: ID of the created insight.
          type: string
        projectId:
          description: ID of the project.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
      required:
      - data
      - id
      type: object
    RetrieveLiftChartPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of paginated lift chart insights.
          items:
            $ref: '#/components/schemas/RetrieveLiftChartIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveListPredictionMetadataObjectsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array of the metadata records.
          items:
            $ref: '#/components/schemas/RetrievePredictionMetadataObject'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    RetrievePredictionMetadataObject:
      properties:
        actualValueColumn:
          description: For time series unsupervised projects only. Actual value column
            can be used to calculate the classification metrics and insights.
          nullable: true
          type: string
          x-versionadded: v2.21
        datasetId:
          description: Deprecated alias for `predictionDatasetId`.
          nullable: true
          type: string
        explanationAlgorithm:
          description: The selected algorithm to use for prediction explanations.
            At present, the only acceptable value is `shap`, which selects the SHapley
            Additive exPlanations (SHAP) explainer. Defaults to null (no prediction
            explanations).
          nullable: true
          type: string
          x-versionadded: v2.21
        featureDerivationWindowCounts:
          description: For time series projects with partial history only. Indicates
            how many points were used in during feature derivation.
          nullable: true
          type: integer
          x-versionadded: v2.24
        forecastPoint:
          description: For time series projects only. The time in the dataset relative
            to which predictions were generated.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.20
        id:
          description: The id of the prediction record.
          type: string
        includesPredictionIntervals:
          description: Whether the predictions include prediction intervals.
          type: boolean
        maxExplanations:
          description: The maximum number of prediction explanations values to be
            returned with each row in the `predictions` json array. Null indicates
            `no limit`. Will be present only if `explanationAlgorithm` was set.
          nullable: true
          type: integer
          x-versionadded: v2.21
        modelId:
          description: The model id used for predictions.
          type: string
        predictionDatasetId:
          description: The dataset id where the prediction data comes from. The field
            is available via `/api/v2/projects/<projectId>/predictionsMetadata/` route
            and replaced on `datasetId`in deprecated `/api/v2/projects/<projectId>/predictions/`
            endpoint.
          nullable: true
          type: string
        predictionIntervalsSize:
          description: For time series projects only. If prediction intervals were
            computed, what percentile they represent. Will be ``None`` if ``includePredictionIntervals``
            is ``False``.
          nullable: true
          type: integer
        predictionThreshold:
          description: Threshold used for binary classification in predictions.
          nullable: true
          type: number
          x-versionadded: v2.22
        predictionsEndDate:
          description: For time series projects only. The end date for bulk predictions,
            exclusive. Note that this parameter was used for generating historical
            predictions using the training data, not for future predictions.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.20
        predictionsStartDate:
          description: For time series projects only. The start date for bulk predictions.
            Note that this parameter was used for generating historical predictions
            using the training data, not for future predictions.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.20
        projectId:
          description: The project id of the predictions.
          type: string
        shapWarnings:
          $ref: '#/components/schemas/ShapWarnings'
          description: Will be present if `explanationAlgorithm` was set to `shap`
            and there were additivity failures during SHAP values calculation.
          nullable: true
          x-versionadded: v2.21
        url:
          description: The url at which you can download the predictions.
          type: string
      required:
      - id
      - includesPredictionIntervals
      - modelId
      - predictionIntervalsSize
      - projectId
      - url
      type: object
    RetrieveResidualsIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/ModelResidualsChartData'
          description: Residuals data.
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
        entityId:
          description: ID of the model.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          nullable: true
          type: string
        id:
          description: ID of the created insight.
          type: string
        projectId:
          description: ID of the project.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          type: string
      required:
      - data
      - id
      type: object
    RetrieveResidualsPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of paginated residuals insights.
          items:
            $ref: '#/components/schemas/RetrieveResidualsIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveRocCurveIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/RocCurveResponse'
          description: Roc curve data.
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
        entityId:
          description: ID of the model.
          type: string
        externalDatasetId:
          description: ID of the external dataset
          nullable: true
          type: string
        id:
          description: ID of the created insight.
          type: string
        projectId:
          description: ID of the project.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
      required:
      - data
      - id
      type: object
    RetrieveRocCurvePaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of paginated roc curve insights.
          items:
            $ref: '#/components/schemas/RetrieveRocCurveIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveShapImpactIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/ShapImpactData'
          description: SHAP impact data.
          x-versionadded: v2.33
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
          x-versionadded: v2.33
        entityId:
          description: ID of the model.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: ID of the external dataset
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: ID of the created insight.
          type: string
          x-versionadded: v2.33
        projectId:
          description: ID of the project.
          type: string
          x-versionadded: v2.33
        source:
          description: Subset of data used to compute the insight.
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
          x-versionadded: v2.33
      required:
      - data
      - id
      type: object
    RetrieveShapImpactPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of paginated SHAP impact insights.
          items:
            $ref: '#/components/schemas/RetrieveShapImpactIndividualResponse'
          maxItems: 10
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveShapMatrixIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/ShapMatrixData'
          description: SHAP matrix data.
          x-versionadded: v2.33
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
          x-versionadded: v2.33
        entityId:
          description: ID of the model.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: ID of the external dataset
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: ID of the created insight.
          type: string
          x-versionadded: v2.33
        projectId:
          description: ID of the project.
          type: string
          x-versionadded: v2.33
        source:
          description: The subset of data used to compute the insight.
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
          x-versionadded: v2.33
      required:
      - data
      - id
      type: object
    RetrieveShapMatrixPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of paginated SHAP matrix insights.
          items:
            $ref: '#/components/schemas/RetrieveShapMatrixIndividualResponse'
          maxItems: 10
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveShapPreviewIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/ShapPreviewData'
          description: SHAP preview data.
          x-versionadded: v2.33
        dataSliceId:
          description: ID of the data slice.
          nullable: true
          type: string
          x-versionadded: v2.33
        entityId:
          description: ID of the model.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: ID of the external dataset
          nullable: true
          type: string
          x-versionadded: v2.33
        id:
          description: ID of the created insight.
          type: string
          x-versionadded: v2.33
        projectId:
          description: ID of the project.
          type: string
          x-versionadded: v2.33
        source:
          description: The subset of data used to compute the insight.
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
          x-versionadded: v2.33
      required:
      - data
      - id
      type: object
    RetrieveShapPreviewPaginatedResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of paginated SHAP preview insights.
          items:
            $ref: '#/components/schemas/RetrieveShapPreviewIndividualResponse'
          maxItems: 10
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ReviewCreate:
      properties:
        changeVersionId:
          description: ID of the change version.
          type: string
        comment:
          description: Free form text to comment on the review.
          maxLength: 10000
          type: string
        status:
          description: Status of the review.
          enum:
          - approved
          - Approved
          - APPROVED
          - changesRequested
          - ChangesRequested
          - CHANGES_REQUESTED
          - commented
          - Commented
          - COMMENTED
          type: string
      required:
      - changeVersionId
      - status
      type: object
    ReviewResponse:
      properties:
        changeRequestId:
          description: ID of the Change Request.
          type: string
        changeVersionId:
          description: ID of the change version.
          type: string
        comment:
          description: Free form text to comment on the review.
          maxLength: 10000
          type: string
        createdAt:
          description: Timestamp when the review was created.
          format: date-time
          type: string
        id:
          description: ID of the review.
          type: string
        status:
          description: Status of the review.
          enum:
          - approved
          - Approved
          - APPROVED
          - changesRequested
          - ChangesRequested
          - CHANGES_REQUESTED
          - commented
          - Commented
          - COMMENTED
          type: string
        userId:
          description: ID of the user, who created the review.
          type: string
        userName:
          description: Email of the user, who created the review
          nullable: true
          type: string
      required:
      - changeRequestId
      - changeVersionId
      - createdAt
      - id
      - status
      - userId
      - userName
      type: object
    ReviewsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of change request reviews.
          items:
            $ref: '#/components/schemas/ReviewResponse'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RocCurveForDatasets:
      properties:
        datasetId:
          description: The ID of dataset which was used to compute ROC curve.
          type: string
        negativeClassPredictions:
          description: List of example predictions for the negative class.
          items:
            type: number
          type: array
        positiveClassPredictions:
          description: List of example predictions for the negative class.
          items:
            type: number
          type: array
        rocPoints:
          $ref: '#/components/schemas/RocPointsResponse'
          description: The ROC curve data for that source, as specified below. Each
            point specifies how the model performed for a particular classification
            threshold.
      required:
      - datasetId
      - negativeClassPredictions
      - positiveClassPredictions
      - rocPoints
      type: object
    RocCurveForDatasetsList:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of ROC curve data for datasets.
          items:
            $ref: '#/components/schemas/RocCurveForDatasets'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    RocCurveResponse:
      properties:
        auc:
          description: AUC value
          nullable: true
          type: number
        kolmogorovSmirnovMetric:
          description: Kolmogorov-Smirnov metric value
          nullable: true
          type: number
        negativeClassPredictions:
          description: List of example predictions for the negative class.
          items:
            description: An example prediction.
            type: number
          type: array
        positiveClassPredictions:
          description: List of example predictions for the positive class.
          items:
            description: An example prediction.
            type: number
          type: array
        rocPoints:
          description: The ROC curve data for that source, as specified below.
          items:
            $ref: '#/components/schemas/RocPointsResponse'
          type: array
      required:
      - auc
      - kolmogorovSmirnovMetric
      - negativeClassPredictions
      - positiveClassPredictions
      - rocPoints
      type: object
    RocPointsResponse:
      properties:
        accuracy:
          description: Accuracy for given threshold.
          type: number
        f1Score:
          description: F1 score.
          type: number
        falseNegativeScore:
          description: False negative score.
          type: integer
        falsePositiveRate:
          description: False positive rate.
          type: number
        falsePositiveScore:
          description: False positive score.
          type: integer
        fractionPredictedAsNegative:
          description: Fraction of data that will be predicted as negative.
          type: number
        fractionPredictedAsPositive:
          description: Fraction of data that will be predicted as positive.
          type: number
        liftNegative:
          description: Lift for the negative class.
          type: number
        liftPositive:
          description: Lift for the positive class.
          type: number
        matthewsCorrelationCoefficient:
          description: Matthews correlation coefficient.
          type: number
        negativePredictiveValue:
          description: Negative predictive value.
          type: number
        positivePredictiveValue:
          description: Positive predictive value.
          type: number
        threshold:
          description: Value of threshold for this ROC point.
          type: number
        trueNegativeRate:
          description: True negative rate.
          type: number
        trueNegativeScore:
          description: True negative score.
          type: integer
        truePositiveRate:
          description: True positive rate.
          type: number
        truePositiveScore:
          description: True positive score.
          type: integer
      required:
      - accuracy
      - f1Score
      - falseNegativeScore
      - falsePositiveRate
      - falsePositiveScore
      - fractionPredictedAsNegative
      - fractionPredictedAsPositive
      - liftNegative
      - liftPositive
      - matthewsCorrelationCoefficient
      - negativePredictiveValue
      - positivePredictiveValue
      - threshold
      - trueNegativeRate
      - trueNegativeScore
      - truePositiveRate
      - truePositiveScore
      type: object
    RuleFitCodeFileCreate:
      properties:
        language:
          description: The desired language of the generated code
          enum:
          - Python
          - Java
          type: string
        modelId:
          description: the RuleFit model to generate code for
          type: string
      required:
      - language
      - modelId
      type: object
    RuleFitCodeFileListResponse:
      properties:
        count:
          description: number of items returned on this page
          type: integer
        data:
          description: each has the same schema as if retrieving the file individually
            from GET /api/v2/projects/(projectId)/ruleFitFiles/(ruleFitFileId)/.
          items:
            $ref: '#/components/schemas/RuleFitCodeFileResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    RuleFitCodeFileResponse:
      properties:
        id:
          description: the ID of the file
          type: string
        isValid:
          description: whether the code passed basic validation checks
          type: boolean
        language:
          description: the language the code is written in (e.g. Python
          enum:
          - Python
          - Java
          type: string
        modelId:
          description: the ID of the RuleFit model
          type: string
        projectId:
          description: the ID of the project the file belongs to
          type: string
      required:
      - id
      - isValid
      - language
      - modelId
      - projectId
      type: object
    RunPreviewStatus:
      properties:
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the testing job's status.
          type: string
          x-versionadded: v2.33
      required:
      - statusId
      type: object
    RuntimeParameterUnified:
      properties:
        allowEmpty:
          default: true
          description: Indicates whether the param must be set before registration
          type: boolean
          x-versionadded: v2.33
        credentialType:
          description: The type of credential, required only for credentials parameters.
          enum:
          - adlsGen2Oauth
          - apiToken
          - azure
          - azureServicePrincipal
          - basic
          - bearer
          - databricksAccessTokenAccount
          - databricksServicePrincipalAccount
          - gcp
          - oauth
          - rsa
          - s3
          - snowflakeKeyPairUserAccount
          - snowflakeOauthUserAccount
          - tableauAccessToken
          nullable: true
          type: string
          x-versionadded: v2.33
        currentValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          description: Given the default and the override, this is the actual current
            value of the parameter.
          nullable: true
          x-versionadded: v2.33
        defaultValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          description: The default value for the given field.
          nullable: true
          x-versionadded: v2.33
        description:
          description: Description how this parameter impacts the running model.
          nullable: true
          type: string
          x-versionadded: v2.33
        fieldName:
          description: The parameter name. This value will be added as an environment
            variable when running custom models.
          type: string
          x-versionadded: v2.33
        maxValue:
          description: The maximum value for a numeric field.
          nullable: true
          type: number
          x-versionadded: v2.33
        minValue:
          description: The minimum value for a numeric field.
          nullable: true
          type: number
          x-versionadded: v2.33
        overrideValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          description: Value set by the user that overrides the default set in the
            definition.
          nullable: true
          x-versionadded: v2.33
        type:
          description: The type of this value.
          enum:
          - boolean
          - credential
          - customMetric
          - deployment
          - modelPackage
          - numeric
          - string
          type: string
          x-versionadded: v2.33
      required:
      - fieldName
      - type
      type: object
    RuntimeParameterValue:
      properties:
        fieldName:
          description: The required field name. This value will be added as an environment
            variable when running custom models.
          type: string
          x-versionadded: v2.33
        type:
          description: The type of this value.
          enum:
          - boolean
          - credential
          - customMetric
          - deployment
          - modelPackage
          - numeric
          - string
          type: string
          x-versionadded: v2.33
        value:
          anyOf:
          - description: The value for the given field.
            maxLength: 4096
            nullable: true
            type: string
          - default: false
            description: The boolean value for the field (default False)
            type: boolean
          - default: null
            description: The numeric value for the field
            type: number
          description: The string, boolean or numeric value for the given field.
          x-versionadded: v2.33
      required:
      - fieldName
      - type
      - value
      type: object
    S3Credentials:
      properties:
        awsAccessKeyId:
          description: The S3 AWS access key ID. Required if configId is not specified.Cannot
            include this parameter if configId is specified.
          type: string
        awsSecretAccessKey:
          description: The S3 AWS secret access key. Required if configId is not specified.Cannot
            include this parameter if configId is specified.
          type: string
        awsSessionToken:
          default: null
          description: The S3 AWS session token for AWS temporary credentials.Cannot
            include this parameter if configId is specified.
          nullable: true
          type: string
        configId:
          description: ID of Secure configurations of credentials shared by admin.If
            specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken
          type: string
        credentialType:
          description: The type of these credentials, 's3' here.
          enum:
          - s3
          type: string
      required:
      - credentialType
      type: object
    S3DataStreamer:
      properties:
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: Use the specified credential to access the url
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        endpointUrl:
          description: Endpoint URL for the S3 connection (omit to use the default)
          format: url
          type: string
          x-versionadded: v2.29
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        type:
          description: Type name for this intake type
          enum:
          - s3
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    S3Intake:
      properties:
        credentialId:
          description: Use the specified credential to access the url
          nullable: true
          type: string
        endpointUrl:
          description: Endpoint URL for the S3 connection (omit to use the default)
          format: url
          type: string
          x-versionadded: v2.29
        format:
          default: csv
          description: Type of input file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        type:
          description: Type name for this intake type
          enum:
          - s3
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    S3Output:
      properties:
        credentialId:
          description: Use the specified credential to access the url
          nullable: true
          type: string
        endpointUrl:
          description: Endpoint URL for the S3 connection (omit to use the default)
          format: url
          type: string
          x-versionadded: v2.29
        format:
          default: csv
          description: Type of output file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        partitionColumns:
          description: For Parquet directory-scoring only. The column names of the
            intake data of which to partition the dataset. Columns are partitioned
            in the order they are given. At least one value is required if scoring
            to a directory (meaning the output url ends with a slash ("/").
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.26
        serverSideEncryption:
          $ref: '#/components/schemas/ServerSideEncryption'
          description: Configure Server-Side Encryption for S3 output
          x-versionadded: v2.29
        type:
          description: Type name for this output type
          enum:
          - s3
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    S3OutputAdaptor:
      properties:
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: Use the specified credential to access the url
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        endpointUrl:
          description: Endpoint URL for the S3 connection (omit to use the default)
          format: url
          type: string
          x-versionadded: v2.29
        format:
          default: csv
          description: Type of output file format
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.25
        partitionColumns:
          description: For Parquet directory-scoring only. The column names of the
            intake data of which to partition the dataset. Columns are partitioned
            in the order they are given. At least one value is required if scoring
            to a directory (meaning the output url ends with a slash ("/").
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.26
        serverSideEncryption:
          $ref: '#/components/schemas/ServerSideEncryption'
          description: Configure Server-Side Encryption for S3 output
          x-versionadded: v2.29
        type:
          description: Type name for this output type
          enum:
          - s3
          type: string
        url:
          description: URL for the CSV file
          format: url
          type: string
      required:
      - type
      - url
      type: object
    SamlAdvancedConfiguration:
      properties:
        digestAlgorithm:
          description: Algorithm for calculating digest.
          enum:
          - DIGEST_RIPEMD160
          - DIGEST_SHA1
          - DIGEST_SHA224
          - DIGEST_SHA256
          - DIGEST_SHA384
          - DIGEST_SHA512
          type: string
        samlAttributesMapping:
          $ref: '#/components/schemas/EnhancedSamlAttributeMapping'
          description: Attribute mapping between DataRobot and IdP.
        samlClientConfiguration:
          $ref: '#/components/schemas/EnhancedSamlClientConfig'
          description: Encryption related parameters.
        signatureAlgorithm:
          description: Algorithm for calculating signature.
          enum:
          - SIG_RSA_SHA1
          - SIG_RSA_SHA224
          - SIG_RSA_SHA256
          - SIG_RSA_SHA384
          - SIG_RSA_SHA512
          type: string
      required:
      - samlAttributesMapping
      - samlClientConfiguration
      type: object
    SamlCertificate:
      properties:
        fileName:
          description: Path to certificate file.
          type: string
        value:
          description: Certificate content.
          type: string
      required:
      - value
      type: object
    SamlGroupMappingResponse:
      properties:
        datarobotGroupId:
          description: DataRobot group ID.
          type: string
        datarobotGroupName:
          description: DataRobot group name.
          type: string
        idpGroupId:
          description: A name of the identity provider group.
          type: string
      required:
      - datarobotGroupId
      - idpGroupId
      type: object
    SamlMetadataFile:
      properties:
        fileName:
          description: Path to IdP metadata file.
          type: string
        value:
          description: IdP metadata.
          type: string
      required:
      - fileName
      - value
      type: object
    SamlSecurityParameters:
      properties:
        allowUnsolicited:
          description: Allow unsolicited.
          type: boolean
        authnRequestsSigned:
          description: Sign auth requests.
          type: boolean
        logoutRequestsSigned:
          description: Sign logout requests.
          type: boolean
        wantAssertionsSigned:
          description: Sign assertions.
          type: boolean
        wantResponseSigned:
          description: Sign response.
          type: boolean
      type: object
    SampleCountField:
      properties:
        columnName:
          description: Column name
          nullable: true
          type: string
      required:
      - columnName
      type: object
    SampleDirectiveCreate:
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/RandomSampleArgumentsCreate'
            default: {}
            description: The interactive sampling config.
          directive:
            description: The directive name.
            enum:
            - random-sample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/DatetimeSampleArgumentsCreate'
            default: {}
            description: The interactive sampling config.
          directive:
            description: The directive name.
            enum:
            - datetime-sample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/LimitDirectiveArguments'
            description: The interactive sampling config.
          directive:
            description: The directive name.
            enum:
            - limit
            type: string
        required:
        - arguments
        - directive
        type: object
    SampleSection:
      type: object
    SampleSize:
      properties:
        type:
          description: Sample size can be specified only as a number of rows for now.
          enum:
          - rows
          type: string
          x-versionadded: v2.27
        value:
          description: Number of rows to ingest during dataset registration.
          exclusiveMinimum: true
          maximum: 1000000
          minimum: 0
          type: integer
          x-versionadded: v2.27
      required:
      - type
      - value
      type: object
    Schedule:
      properties:
        dayOfMonth:
          description: The date(s) of the month that the job will run. Allowed values
            are either ``[1 ... 31]`` or ``["*"]`` for all days of the month. This
            field is additive with ``dayOfWeek``, meaning the job will run both on
            the date(s) defined in this field and the day specified by ``dayOfWeek``
            (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth``
            is set to ``["*"]`` and ``dayOfWeek`` is defined, the scheduler will trigger
            on every day of the month that matches ``dayOfWeek`` (for example, Tuesday
            the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are
            ignored.
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
            - 22
            - 23
            - 24
            - 25
            - 26
            - 27
            - 28
            - 29
            - 30
            - 31
          type: array
        dayOfWeek:
          description: The day(s) of the week that the job will run. Allowed values
            are ``[0 .. 6]``, where (Sunday=0), or ``["*"]``, for all days of the
            week. Strings, either 3-letter abbreviations or the full name of the day,
            can be used interchangeably (e.g., "sunday", "Sunday", "sun", or "Sun",
            all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning
            the job will run both on the date specified by ``dayOfMonth`` and the
            day defined in this field.
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - sunday
            - SUNDAY
            - Sunday
            - monday
            - MONDAY
            - Monday
            - tuesday
            - TUESDAY
            - Tuesday
            - wednesday
            - WEDNESDAY
            - Wednesday
            - thursday
            - THURSDAY
            - Thursday
            - friday
            - FRIDAY
            - Friday
            - saturday
            - SATURDAY
            - Saturday
            - sun
            - SUN
            - Sun
            - mon
            - MON
            - Mon
            - tue
            - TUE
            - Tue
            - wed
            - WED
            - Wed
            - thu
            - THU
            - Thu
            - fri
            - FRI
            - Fri
            - sat
            - SAT
            - Sat
          type: array
        hour:
          description: The hour(s) of the day that the job will run. Allowed values
            are either ``["*"]`` meaning every hour of the day or ``[0 ... 23]``.
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
            - 22
            - 23
          type: array
        minute:
          description: The minute(s) of the day that the job will run. Allowed values
            are either ``["*"]`` meaning every minute of the day or``[0 ... 59]``.
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
            - 22
            - 23
            - 24
            - 25
            - 26
            - 27
            - 28
            - 29
            - 30
            - 31
            - 32
            - 33
            - 34
            - 35
            - 36
            - 37
            - 38
            - 39
            - 40
            - 41
            - 42
            - 43
            - 44
            - 45
            - 46
            - 47
            - 48
            - 49
            - 50
            - 51
            - 52
            - 53
            - 54
            - 55
            - 56
            - 57
            - 58
            - 59
          type: array
        month:
          description: 'The month(s) of the year that the job will run. Allowed values
            are either ``[1 ... 12]`` or ``["*"]`` for all months of the year. Strings,
            either 3-letter abbreviations or the full name of the month, can be used
            interchangeably (e.g., "jan" or "october"). Months that are not compatible
            with ``dayOfMonth`` are ignored, for example ``{"dayOfMonth": [31], "month":["feb"]}``.'
          items:
            anyOf:
            - type: number
            - type: string
            enum:
            - '*'
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - january
            - JANUARY
            - January
            - february
            - FEBRUARY
            - February
            - march
            - MARCH
            - March
            - april
            - APRIL
            - April
            - may
            - MAY
            - May
            - june
            - JUNE
            - June
            - july
            - JULY
            - July
            - august
            - AUGUST
            - August
            - september
            - SEPTEMBER
            - September
            - october
            - OCTOBER
            - October
            - november
            - NOVEMBER
            - November
            - december
            - DECEMBER
            - December
            - jan
            - JAN
            - Jan
            - feb
            - FEB
            - Feb
            - mar
            - MAR
            - Mar
            - apr
            - APR
            - Apr
            - jun
            - JUN
            - Jun
            - jul
            - JUL
            - Jul
            - aug
            - AUG
            - Aug
            - sep
            - SEP
            - Sep
            - oct
            - OCT
            - Oct
            - nov
            - NOV
            - Nov
            - dec
            - DEC
            - Dec
          type: array
      required:
      - dayOfMonth
      - dayOfWeek
      - hour
      - minute
      - month
      type: object
    ScheduledJobResponse:
      properties:
        createdBy:
          description: User name of the creator
          nullable: true
          type: string
        deploymentId:
          description: ID of the deployment this scheduled job is created from.
          nullable: true
          type: string
        enabled:
          description: True if the job is enabled and false if the job is disabled.
          type: boolean
        id:
          description: ID of scheduled prediction job
          type: string
        name:
          description: Name of the scheduled job.
          nullable: true
          type: string
        schedule:
          $ref: '#/components/schemas/Schedule'
          description: Schedule describing when to refresh the dataset, the smallest
            schedule allowed is daily. Can be null is job was created without a schedule.
        scheduledJobId:
          description: ID of this scheduled job.
          type: string
        status:
          $ref: '#/components/schemas/ScheduledJobStatus'
          description: Object containing status information about the scheduled job.
        typeId:
          description: Job type of the scheduled job
          type: string
        updatedAt:
          description: Time of last modification
          format: date-time
          nullable: true
          type: string
      required:
      - enabled
      - id
      - schedule
      - scheduledJobId
      - status
      - typeId
      type: object
    ScheduledJobStatus:
      properties:
        lastFailedRun:
          description: Date and time of the last failed run.
          format: date-time
          nullable: true
          type: string
        lastSuccessfulRun:
          description: Date and time of the last successful run.
          format: date-time
          nullable: true
          type: string
        nextRunTime:
          description: Date and time of the next run.
          format: date-time
          nullable: true
          type: string
        queuePosition:
          description: Position of the job in the queue Job. The value will show 0
            if the job is about to run, otherwise, the number will be greater than
            0 if currently queued, or None if the job is not currently running.
          minimum: 0
          nullable: true
          type: integer
        running:
          description: '`true` or `false` depending on whether the job is currently
            running.'
          type: boolean
      required:
      - running
      type: object
    ScheduledJobsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of scheduled jobs
          items:
            $ref: '#/components/schemas/ScheduledJobResponse'
          maxItems: 100
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
        updatedAt:
          description: Time of last modification
          format: date-time
          type: string
        updatedBy:
          description: User ID of last modifier
          type: string
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ScheduledReportOnDemmand:
      properties:
        id:
          description: ID of Scheduled report record.
          type: string
      required:
      - id
      type: object
    SecondaryDataset:
      properties:
        catalogId:
          description: Id of the catalog item version.
          type: string
        catalogVersionId:
          description: Id of the catalog item.
          type: string
        identifier:
          description: Short name of this table (used directly as part of generated
            feature names).
          maxLength: 45
          minLength: 1
          type: string
        snapshotPolicy:
          default: latest
          description: Type of snapshot policy to use by the dataset.
          enum:
          - specified
          - latest
          - dynamic
          type: string
      required:
      - catalogId
      - catalogVersionId
      - identifier
      type: object
    SecondaryDatasetConfig:
      properties:
        featureEngineeringGraphId:
          description: Id of the feature engineering graph
          type: string
        secondaryDatasets:
          description: list of secondary datasets used by the feature engineering
            graph
          items:
            $ref: '#/components/schemas/SecondaryDataset'
          type: array
      required:
      - featureEngineeringGraphId
      - secondaryDatasets
      type: object
    SecondaryDatasetConfigListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Secondary dataset configurations.
          items:
            $ref: '#/components/schemas/ProjectSecondaryDatasetConfigResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    SecondaryDatasetConfigResponse:
      properties:
        created:
          description: DR-formatted datetime, null for legacy (before DR 6.0) db records
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.24
        creatorFullName:
          description: Fullname or email of the user created this config. null for
            legacy (before DR 6.0) db records
          nullable: true
          type: string
          x-versionadded: v2.24
        creatorUserId:
          description: ID of the user created this config, null for legacy (before
            DR 6.0) db records
          nullable: true
          type: string
          x-versionadded: v2.24
        credentialIds:
          description: List of credentials used by the secondary datasets if the datasets
            used in the configuration are from datasource
          items:
            $ref: '#/components/schemas/DatasetsCredential'
          nullable: true
          type: array
        featurelistId:
          description: Id of the feature list
          nullable: true
          type: string
          x-versionadded: v2.24
        isDefault:
          description: Secondary datasets config is default config or not
          type: boolean
        isDeleted:
          description: Secondary datasets config is soft deleted or not
          type: boolean
        name:
          description: Name of the secondary datasets config
          nullable: true
          type: string
        projectId:
          description: ID of the project
          nullable: true
          type: string
        secondaryDatasetConfigId:
          description: ID of the secondary datasets configuration
          type: string
        secondaryDatasets:
          description: List of secondary datasets used in the config
          items:
            $ref: '#/components/schemas/DeploymentSecondaryDataset'
          type: array
          x-versionadded: v2.24
      required:
      - created
      - creatorFullName
      - creatorUserId
      - featurelistId
      - isDefault
      - isDeleted
      - name
      - projectId
      - secondaryDatasetConfigId
      type: object
    SecondaryDatasetConfigUpdate:
      properties:
        credentialsIds:
          description: List of credentials used by the secondary datasets
          items:
            $ref: '#/components/schemas/DatasetsCredential'
          type: array
        secondaryDatasetConfigId:
          description: ID of the secondary datasets configuration to be used at the
            time of prediction
          type: string
      required:
      - secondaryDatasetConfigId
      type: object
    SecondaryDatasetCreate:
      properties:
        config:
          description: Graph-specific secondary datasets. Deprecated in version v2.23
          items:
            $ref: '#/components/schemas/SecondaryDatasetConfig'
          type: array
        featurelistId:
          description: Feature list ID of the configuration.
          type: string
        modelId:
          description: ID of the model.
          type: string
        name:
          description: Name of the configuration.
          type: string
        save:
          default: true
          description: Determines if the configuration will be saved. If set to False
            the configuration is validated but not saved. Defaults to True.
          type: boolean
        secondaryDatasets:
          description: List of secondary dataset definitions to use in the configuration.
          items:
            $ref: '#/components/schemas/SecondaryDataset'
          type: array
      required:
      - name
      type: object
    SecondaryDatasetResponse:
      properties:
        catalogId:
          description: ID of the catalog item.
          nullable: true
          type: string
        catalogVersionId:
          description: ID of the catalog version.
          type: string
        identifier:
          description: Short name of this table (used directly as part of generated
            feature names).
          maxLength: 45
          minLength: 1
          type: string
        requiredFeatures:
          description: List of required feature names used by the table.
          items:
            type: string
          type: array
        snapshotPolicy:
          description: Policy to be used by a dataset while making prediction.
          enum:
          - specified
          - latest
          - dynamic
          nullable: true
          type: string
      required:
      - catalogId
      - catalogVersionId
      - identifier
      - snapshotPolicy
      type: object
    SecondaryDatasetsConfig:
      properties:
        configId:
          description: ID of the secondary datasets configuration
          type: string
        configName:
          description: Name of the secondary datasets config
          type: string
        updated:
          description: Timestamp when configuration was updated on the given deployment
          type: string
        username:
          description: Name of the user who made the update
          type: string
      required:
      - configId
      - configName
      - updated
      - username
      type: object
    SecondaryDatasetsConfigListResponse:
      properties:
        count:
          description: Number of items
          type: integer
        data:
          description: Secondary datasets configuration history.
          items:
            $ref: '#/components/schemas/SecondaryDatasetsConfig'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    SectionCustom:
      properties:
        description:
          description: Section description
          nullable: true
          type: string
        highlightedText:
          description: Highlighted text of the section, optionally separated by ``\n``
            to split paragraphs.
          maxLength: 5000
          type: string
        instructions:
          $ref: '#/components/schemas/InstructionsField'
          description: Section instructions
          nullable: true
        locked:
          description: Locked section flag
          type: boolean
        regularText:
          description: Regular text of the section, optionally separated by ``\n``
            to split paragraphs.
          maxLength: 5000
          type: string
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, e.g. the structure is recursive. The limit of nesting
            sections is 5. Total number of sections is limited to 500. '
          items:
            $ref: '#/components/schemas/SampleSection'
          nullable: true
          type: array
        title:
          description: Section Title
          maxLength: 500
          type: string
        type:
          description: 'Section with user-defined content. It can be a section title
            or summary. '
          enum:
          - custom
          type: string
      required:
      - highlightedText
      - regularText
      - title
      - type
      type: object
    SectionDataRobot:
      properties:
        contentId:
          description: The identifier of the content in the section. This attribute
            identifies what is going to be rendered in the section.
          enum:
          - MODEL_DESCRIPTION_AND_OVERVIEW
          - MODEL_DESCRIPTION_AND_OVERVIEW_EXTERNAL_PREDICTION
          - OVERVIEW_OF_MODEL_RESULTS
          - MODEL_DEVELOPMENT_OVERVIEW_SUB
          - TS_MODEL_DEVELOPMENT_OVERVIEW_SUB
          - AD_MODEL_DEVELOPMENT_OVERVIEW_SUB
          - MODEL_DEVELOPMENT_OVERVIEW_SUB_EXTERNAL_PREDICTION
          - MODEL_METHODOLOGY
          - MODEL_METHODOLOGY_EXTERNAL_PREDICTION
          - LITERATURE_REVIEW_AND_REFERENCES
          - ALTERNATIVE_MODEL_FRAMEWORKS_AND_THEORIES_CONSIDERED
          - PERSONALLY_IDENTIFIABLE_INFORMATION
          - DATA_PARTITIONING_METHODOLOGY
          - AD_DATA_PARTITIONING_METHODOLOGY
          - TS_DATA_PARTITIONING_METHODOLOGY
          - QUANTITATIVE_ANALYSIS
          - FINAL_MODEL_VARIABLES
          - VALIDATION_STABILITY
          - MODEL_PERFORMANCE
          - ACCURACY_LIFT_CHART
          - MULTICLASS_ACCURACY_LIFT_CHART
          - SENSITIVITY_ANALYSIS
          - SENSITIVITY_ANALYSIS_NO_NULL_IMPUTATION
          - AD_SENSITIVITY_ANALYSIS
          - ACCURACY_OVER_TIME
          - ANOMALY_OVER_TIME
          - ACCURACY_ROC
          - MULTICLASS_CONFUSION
          - MODEL_VERSION_CONTROL
          - CUSTOM_INFERENCE_VERSION_CONTROL
          - FEATURE_ASSOCIATION_MATRIX
          - BIAS_AND_FAIRNESS
          - BIAS_AND_FAIRNESS_EXTERNAL_PREDICTION
          - HOW_TO_USE
          - PREFACE
          - TS_MODEL_PERFORMANCE
          - EXECUTIVE_SUMMARY_AND_MODEL_OVERVIEW
          - MODEL_DATA_OVERVIEW
          - MODEL_THEORETICAL_FRAMEWORK_AND_METHODOLOGY
          - MODEL_PERFORMANCE_AND_STABILITY
          - CUSTOM_INFERENCE_PERFORMANCE_AND_STABILITY
          - SENSITIVITY_TESTING_AND_ANALYSIS
          - MODEL_IMPLEMENTATION_AND_OUTPUT_REPORTING
          - MODEL_STAKEHOLDERS
          - MODEL_DEVELOPMENT_PURPOSE_AND_INTENDED_USE
          - MODEL_INTERDEPENDENCIES
          - DATA_SOURCE_OVERVIEW_AND_APPROPRIATENESS
          - INPUT_DATA_EXTRACTION_PREPARATION
          - DATA_ASSUMPTIONS
          - CUSTOM_INFERENCE_MODELING_FEATURES
          - MODEL_ASSUMPTIONS
          - VARIABLE_SELECTION
          - VARIABLE_SELECTION_EXTERNAL_PREDICTION
          - TS_VARIABLE_SELECTION
          - EXPERT_JUDGEMENT_AND_VAR_SELECTION
          - KEY_RELATIONSHIPS
          - AD_KEY_RELATIONSHIPS
          type: string
        description:
          description: Section description
          nullable: true
          type: string
        instructions:
          $ref: '#/components/schemas/InstructionsField'
          description: Section instructions
          nullable: true
        locked:
          description: Locked section flag
          type: boolean
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, e.g. the structure is recursive. The limit of nesting
            sections is 5. Total number of sections is limited to 500. '
          items:
            $ref: '#/components/schemas/SampleSection'
          nullable: true
          type: array
        title:
          description: Section Title
          maxLength: 500
          type: string
        type:
          description: Section owned by DataRobot. The content of this section type
            is controlled by DataRobot (see ``contentId`` attribute). Users can add
            sub-sections to it.
          enum:
          - datarobot
          type: string
      required:
      - contentId
      - title
      - type
      type: object
    SectionTableOfContents:
      properties:
        locked:
          description: Locked section flag
          type: boolean
        title:
          description: Section Title
          maxLength: 500
          type: string
        type:
          description: Table of contents. This section has no additional attributes.
          enum:
          - table_of_contents
          type: string
      required:
      - title
      - type
      type: object
    SectionUser:
      properties:
        description:
          description: Section description
          nullable: true
          type: string
        highlightedText:
          description: Highlighted text of the section, optionally separated by ``\n``
            to split paragraphs.
          maxLength: 5000
          type: string
        instructions:
          $ref: '#/components/schemas/InstructionsField'
          description: Section instructions
          nullable: true
        locked:
          description: Locked section flag
          type: boolean
        regularText:
          description: Regular text of the section, optionally separated by ``\n``
            to split paragraphs.
          maxLength: 5000
          type: string
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, e.g. the structure is recursive. The limit of nesting
            sections is 5. Total number of sections is limited to 500. '
          items:
            $ref: '#/components/schemas/SampleSection'
          nullable: true
          type: array
        title:
          description: Section Title
          maxLength: 500
          type: string
        type:
          description: Section with user-defined content. Those sections may contain
            text generated by the user.
          enum:
          - user
          type: string
      required:
      - highlightedText
      - regularText
      - title
      - type
      type: object
    SegmentAnalysis:
      properties:
        attributes:
          description: The list of segment attributes selected for tracking.
          items:
            type: string
          type: array
        enabled:
          description: Indicates whether service health, drift, and accuracy are tracked
            for segments of prediction data.
          type: boolean
      required:
      - enabled
      type: object
    SegmentAnalysisUpdate:
      properties:
        attributes:
          description: The segment attributes to be tracked. Note that only categorical
            columns can be specified as tracked segment attributes. The target column
            may not be specified
          items:
            type: string
          type: array
        enabled:
          description: Indicates whether service health, drift, and accuracy are tracked
            for segments of prediction data.
          type: boolean
      required:
      - enabled
      type: object
    SegmentChampionModelUpdate:
      properties:
        clone:
          default: false
          description: Clone current combined model and assign champion to the new
            combined model.
          type: boolean
          x-versionadded: v2.29
        modelId:
          description: The ID of segment champion model.
          type: string
      required:
      - modelId
      type: object
    SegmentChampionModelUpdateResponse:
      properties:
        combinedModelId:
          description: The ID of the combined model that has been updated.
          type: string
      required:
      - combinedModelId
      type: object
    SegmentProjectModelResponse:
      properties:
        modelId:
          description: ID of segment champion model.
          nullable: true
          type: string
        projectId:
          description: ID of the project used for this segment.
          nullable: true
          type: string
        segment:
          description: Segment name.
          type: string
      required:
      - modelId
      - projectId
      - segment
      type: object
    SegmentationDataMappingResponse:
      properties:
        segment:
          description: The segment name associated with the multiseries ID column
            by the segmentation task
          type: string
        seriesId:
          description: The multiseries ID column used to identify series for segmentation
          type: string
      required:
      - segment
      - seriesId
      type: object
    SegmentationEDACompletedResponse:
      properties:
        maxDate:
          description: Latest date in segment.
          format: date-time
          type: string
        minDate:
          description: Earliest date in segment.
          format: date-time
          type: string
        name:
          description: Name of the segment.
          type: string
        numberOfRows:
          description: Number of rows in segment.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        sizeInBytes:
          description: Size of segment in bytes.
          exclusiveMinimum: true
          minimum: 0
          type: integer
      required:
      - maxDate
      - minDate
      - name
      - numberOfRows
      - sizeInBytes
      type: object
    SegmentationResultsCompletedResponse:
      properties:
        name:
          description: Name of the segmentation task job
          type: string
        segmentationTaskId:
          description: Id of the completed segmentation task
          type: string
        segmentsCount:
          description: Number of segments produced by the task
          type: integer
        segmentsEda:
          description: Array of segments EDA information.
          items:
            $ref: '#/components/schemas/SegmentationEDACompletedResponse'
          type: array
        url:
          description: Url to retrieve detailed information about the segmentation
            task
          type: string
      required:
      - name
      - segmentationTaskId
      - segmentsCount
      - segmentsEda
      - url
      type: object
    SegmentationResultsFailedResponse:
      properties:
        message:
          description: Response containing the error message from the segmentation
            task
          type: string
        name:
          description: Name of the segmentation task job
          type: string
        parameters:
          $ref: '#/components/schemas/AllowExtra'
          description: Parameters submitted by the user to the failed job
      required:
      - message
      - name
      - parameters
      type: object
    SegmentationResultsResponse:
      properties:
        completedJobs:
          description: List of completed segmentation tasks
          items:
            $ref: '#/components/schemas/SegmentationResultsCompletedResponse'
          type: array
        failedJobs:
          description: List of failed segmentation tasks
          items:
            $ref: '#/components/schemas/SegmentationResultsFailedResponse'
          type: array
        numberOfJobs:
          description: Total number of completed and failed jobs processed
          type: integer
      required:
      - completedJobs
      - failedJobs
      - numberOfJobs
      type: object
    SegmentationTaskCreate:
      properties:
        datetimePartitionColumn:
          description: The date column that will be used to identify the date in time
            series segmentation.
          type: string
        modelPackageId:
          description: Model package id for using an external model registry package.
          type: string
        multiseriesIdColumns:
          description: List of one or more names of multiseries id columns.
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        target:
          description: The target for the dataset
          type: string
        useAutomatedSegmentation:
          default: false
          description: Enable the use of automated segmentation tasks
          type: boolean
        useTimeSeries:
          default: false
          description: Enable time series based segmentation tasks
          type: boolean
        userDefinedSegmentIdColumns:
          description: List of one or more names of columns to be used for user-defined
            business rule segmentations.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - target
      type: object
    SegmentationTaskDataResponse:
      properties:
        clusteringModelId:
          description: Id of the model used by the segmentation task for automated
            segmentation
          nullable: true
          type: string
        clusteringModelName:
          description: Name of the model used by the segmentation task for automated
            segmentation
          nullable: true
          type: string
        clusteringProjectId:
          description: Id of the project used by the segmentation task for automated
            segmentation
          nullable: true
          type: string
        datetimePartitionColumn:
          description: Name of the datetime partitioning column used by the segmentation
            task
          type: string
        modelPackageId:
          description: External model package id used by the segmentation task for
            automated segmentation
          type: string
        multiseriesIdColumns:
          description: The multiseries id columns used by the segmentation task
          items:
            type: string
          type: array
        userDefinedSegmentIdColumns:
          description: The user defined segmentation columns used by the segmentation
            task
          items:
            type: string
          type: array
      type: object
    SegmentationTaskListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of the segmentation tasks that are associated with the
            project Id.
          items:
            $ref: '#/components/schemas/SegmentationTaskResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    SegmentationTaskMetadataResponse:
      properties:
        useAutomatedSegmentation:
          description: Segmentation task uses automated segmentation
          type: boolean
        useMultiseriesIdColumns:
          description: Segmentation task uses a multiseries column
          type: boolean
        useTimeSeries:
          description: Segmentation task is a time series task
          type: boolean
      required:
      - useAutomatedSegmentation
      - useMultiseriesIdColumns
      - useTimeSeries
      type: object
    SegmentationTaskResponse:
      properties:
        created:
          description: Date and time when the segmentation task was originally created
          format: date-time
          type: string
        data:
          $ref: '#/components/schemas/SegmentationTaskDataResponse'
          description: Data for the segmentation task
        metadata:
          $ref: '#/components/schemas/SegmentationTaskMetadataResponse'
          description: Metadata for the segmentation task
        name:
          description: Name of the segmentation task
          type: string
        projectId:
          description: Id of the parent project associated with the segmentation task
          type: string
        segmentationTaskId:
          description: Id of the segmentation task
          type: string
        segments:
          description: Names of the unique segments generated by the segmentation
            task
          items:
            type: string
          type: array
        segmentsCount:
          description: Number of segments generated by the segmentation task
          type: integer
        segmentsEda:
          description: Array of segments EDA information.
          items:
            $ref: '#/components/schemas/SegmentationEDACompletedResponse'
          type: array
        type:
          description: Type of segmentation task (e.g. AutoML, AutoTS)
          type: string
      required:
      - created
      - data
      - metadata
      - name
      - projectId
      - segmentationTaskId
      - segments
      - segmentsCount
      - segmentsEda
      - type
      type: object
    SegmentationTaskSegmentMappingsResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of segmentation mappings.
          items:
            $ref: '#/components/schemas/SegmentationDataMappingResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    Select:
      properties:
        supportsGridSearch:
          description: When True, Grid Search is supported for this parameter.
          type: boolean
        values:
          description: List of valid values for this field.
          items:
            type: string
          type: array
      required:
      - supportsGridSearch
      - values
      type: object
    SeriesAccuracyCompute:
      properties:
        computeAllSeries:
          default: false
          description: Indicates whether to calculate accuracy for all series or only
            first 1000 (sorted by name).
          type: boolean
          x-versionadded: '2.22'
      type: object
    SeriesAccuracyRetrieveDataResponse:
      properties:
        backtestingScore:
          description: The backtesting score for this series. If backtesting has not
            been run for this model, this score will be null.
          nullable: true
          type: number
        cluster:
          description: 'The cluster associated with this series. '
          nullable: true
          type: string
        duration:
          description: The duration of this series formatted as an ISO 8601 duration
            string.
          format: duration
          type: string
        endDate:
          description: The ISO-formatted end date of this series.
          format: date-time
          nullable: true
          type: string
        holdoutScore:
          description: The holdout set score for this series. If holdout is locked
            for the project, this score will be null.
          nullable: true
          type: number
        multiseriesId:
          description: A DataRobot-generated ID corresponding to a single series in
            a multiseries dataset.
          type: string
        multiseriesValues:
          description: The actual values of series ID columns from the dataset.
          items:
            type: string
          type: array
        rowCount:
          description: The number of rows available for this series in the input dataset.
          type: integer
        startDate:
          description: The ISO-formatted start date of this series.
          format: date-time
          nullable: true
          type: string
        targetAverage:
          description: For regression projects, this is the average (mean) value of
            target values for this series.For classification projects, this is the
            ratio of the positive class in the target for this series.
          nullable: true
          oneOf:
          - type: string
          - type: number
        validationScore:
          description: The validation set score for this series
          nullable: true
          type: number
      required:
      - backtestingScore
      - duration
      - multiseriesId
      - multiseriesValues
      - rowCount
      - validationScore
      type: object
    SeriesAccuracyRetrieveResponse:
      properties:
        data:
          description: An array of available multiseries identifiers and column values.
          items:
            $ref: '#/components/schemas/SeriesAccuracyRetrieveDataResponse'
          type: array
        next:
          description: A URL pointing to the next page (if null, there is no next
            page).
          nullable: true
          type: string
        previous:
          description: A URL pointing to the previous page (if null, there is no previous
            page).
          nullable: true
          type: string
        querySeriesCount:
          description: The total number of series after filtering is applied.
          type: integer
        totalSeriesCount:
          description: The total number of series in the project dataset.
          type: integer
      required:
      - data
      - querySeriesCount
      - totalSeriesCount
      type: object
    ServerSideEncryption:
      properties:
        algorithm:
          description: The server-side encryption algorithm used when storing this
            object in Amazon S3 (for example, AES256, aws:kms).
          type: string
        customerAlgorithm:
          description: Specifies the algorithm to use to when encrypting the object
            (for example, AES256).
          type: string
        customerKey:
          description: Specifies the customer-provided encryption key for Amazon S3
            to use in encrypting data. This value is used to store the object and
            then it is discarded; Amazon S3 does not store the encryption key. The
            key must be appropriate for use with the algorithm specified in customerAlgorithm.
            The key must be sent as an base64 encoded string.
          type: string
        kmsEncryptionContext:
          description: Specifies the Amazon Web Services KMS Encryption Context to
            use for object encryption. The value of this header is a base64-encoded
            UTF-8 string holding JSON with the encryption context key-value pairs.
          type: string
        kmsKeyId:
          description: Specifies the ID of the symmetric customer managed key to use
            for object encryption.
          type: string
      type: object
    ServiceHealth:
      properties:
        batchCount:
          description: Number of recent batches used to compute service health status,
            only applicable to deployments with batch monitoring enabled.
          enum:
          - '1'
          - '5'
          - '10'
          - '50'
          - '100'
          - '1000'
          - '10000'
          type: string
          x-versionadded: v2.33
      required:
      - batchCount
      type: object
    ServiceStatsForBatchRetrieveResponse:
      properties:
        batches:
          description: Info of the batches the metric is aggregated on.
          items:
            $ref: '#/components/schemas/Batch'
          type: array
          x-versionadded: v2.33
        metrics:
          $ref: '#/components/schemas/ServiceStatsMetricsForBatch'
          description: Service health metrics of the deployment
          x-versionadded: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - batches
      - metrics
      type: object
    ServiceStatsForTimeRangeResponse:
      properties:
        metrics:
          $ref: '#/components/schemas/ServiceStatsMetricsForTimeRange'
          description: Service health metrics of the deployment
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: An object with the keys "start" and "end" defining the period.
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - metrics
      - period
      type: object
    ServiceStatsMetricsForBatch:
      properties:
        cacheHitRatio:
          description: Number of cache hits.
          nullable: true
          type: number
          x-versionadded: v2.33
        executionTime:
          description: Request execution time at executionTimeQuantile (in milliseconds).
          nullable: true
          type: number
          x-versionadded: v2.33
        numConsumers:
          description: Number of unique users performing requests.
          nullable: true
          type: integer
          x-versionadded: v2.33
        responseTime:
          description: Request response time at responseTimeQuantile (in milliseconds).
          nullable: true
          type: number
          x-versionadded: v2.33
        serverErrorRate:
          description: Ratio of server errors to the total number of requests.
          nullable: true
          type: number
          x-versionadded: v2.33
        slowRequests:
          description: Number of requests with response time greater than slowRequestsThreshold
          nullable: true
          type: integer
          x-versionadded: v2.33
        totalPredictions:
          description: Total number of prediction rows.
          nullable: true
          type: integer
          x-versionadded: v2.33
        totalRequests:
          description: Total number of prediction requests performed.
          nullable: true
          type: integer
          x-versionadded: v2.33
        userErrorRate:
          description: Ratio of user errors to the total number of requests.
          nullable: true
          type: number
          x-versionadded: v2.33
      required:
      - cacheHitRatio
      - executionTime
      - numConsumers
      - responseTime
      - serverErrorRate
      - slowRequests
      - totalPredictions
      - totalRequests
      - userErrorRate
      type: object
    ServiceStatsMetricsForTimeRange:
      properties:
        cacheHitRatio:
          description: Number of cache hits.
          nullable: true
          type: number
        executionTime:
          description: Request execution time at executionTimeQuantile (in milliseconds).
          nullable: true
          type: number
        medianLoad:
          description: Median of the request rate (in requests per minute).
          nullable: true
          type: number
        numConsumers:
          description: Number of unique users performing requests.
          nullable: true
          type: integer
        peakLoad:
          description: Maximum of the request rate (in requests per minute).
          nullable: true
          type: number
        responseTime:
          description: Request response time at responseTimeQuantile (in milliseconds).
          nullable: true
          type: number
        serverErrorRate:
          description: Ratio of server errors to the total number of requests.
          nullable: true
          type: number
        slowRequests:
          description: Number of requests with response time greater than slowRequestsThreshold
          nullable: true
          type: integer
        totalPredictions:
          description: Total number of prediction rows.
          nullable: true
          type: integer
        totalRequests:
          description: Total number of prediction requests performed.
          nullable: true
          type: integer
        userErrorRate:
          description: Ratio of user errors to the total number of requests.
          nullable: true
          type: number
      required:
      - cacheHitRatio
      - executionTime
      - medianLoad
      - numConsumers
      - peakLoad
      - responseTime
      - serverErrorRate
      - slowRequests
      - totalPredictions
      - totalRequests
      - userErrorRate
      type: object
    ServiceStatsOverBatchBucket:
      properties:
        batch:
          $ref: '#/components/schemas/Batch'
          description: Info of the batch the bucket is associated with.
          x-versionadded: v2.33
        value:
          description: Value of the metric in the bucket.
          nullable: true
          type: number
          x-versionadded: v2.33
      required:
      - batch
      - value
      type: object
    ServiceStatsOverBatchResponse:
      properties:
        buckets:
          description: An array of buckets, representing service health stats of the
            deployment over selected batches.
          items:
            $ref: '#/components/schemas/ServiceStatsOverBatchBucket'
          type: array
          x-versionadded: v2.33
        metric:
          description: Name of the metric requested.
          type: string
          x-versionadded: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
      required:
      - buckets
      - metric
      type: object
    ServiceStatsOverTimeBucket:
      properties:
        period:
          $ref: '#/components/schemas/TimeRange'
          description: An object with the keys "start" and "end" defining the period.
        value:
          description: Value of the metric in the bucket. Null if no value
          nullable: true
          type: number
      required:
      - period
      - value
      type: object
    ServiceStatsOverTimeResponse:
      properties:
        buckets:
          description: An array of bucket, representing service health stats of the
            deployment over time.
          items:
            $ref: '#/components/schemas/ServiceStatsOverTimeBucket'
          type: array
        metric:
          description: Name of the metric requested.
          type: string
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/ServiceStatsOverTimeBucket'
          description: A bucket object covering whole start/end time range
      required:
      - buckets
      - metric
      - summary
      type: object
    SetCredentialsAssociationRequest:
      properties:
        isDefault:
          default: false
          description: Whether this credentials' association with the given object
            is default for given session user.
          type: boolean
      type: object
    ShapExplanationResponse:
      properties:
        feature:
          description: Feature name
          type: string
        featureValue:
          description: Feature value for this row. First 50 characters are returned.
          type: string
        strength:
          description: Shapley value for this feature and row.
          type: number
      required:
      - feature
      - featureValue
      - strength
      type: object
    ShapImpactData:
      properties:
        baseValue:
          description: Mean of raw model predictions for the training data.
          items:
            type: number
          type: array
          x-versionadded: v2.33
        link:
          description: Link function used to connect the SHAP importance values to
            the model output.
          type: string
          x-versionadded: v2.33
        rowCount:
          description: Number of rows used to calculate SHAP impact. If ``rowCount``
            is not specified, the value returned is ``null``.
          nullable: true
          type: integer
          x-versionadded: v2.33
        shapImpacts:
          description: SHAP impact values.
          items:
            items:
              type: number
            type: array
          type: array
          x-versionadded: v2.33
      required:
      - baseValue
      - link
      - rowCount
      - shapImpacts
      type: object
    ShapImpactRetrieveResponse:
      properties:
        count:
          description: The number of shapImpact object returned
          type: integer
        rowCount:
          description: The number of rows from dataset to use.
          type: integer
        shapImpacts:
          description: A list which contains shap impact scores for top 1000 features
            used by a model
          items:
            $ref: '#/components/schemas/ShapImpactsResponse'
          maxItems: 1000
          minItems: 1
          type: array
      required:
      - count
      - shapImpacts
      type: object
    ShapImpactsResponse:
      properties:
        featureName:
          description: The feature name in dataset
          type: string
        impactNormalized:
          description: The normalized impact score value (largest value is 1)
          type: number
        impactUnnormalized:
          description: The raw impact score value
          type: number
      required:
      - featureName
      - impactNormalized
      - impactUnnormalized
      type: object
    ShapMatrixData:
      properties:
        baseValue:
          description: The mean of the raw model predictions for the training data.
          items:
            type: number
          type: array
          x-versionadded: v2.33
        colnames:
          description: The names of each column in the SHAP matrix.
          items:
            type: string
          type: array
          x-versionadded: v2.33
        linkFunction:
          description: The link function used to connect the feature importance values
            to the model output.
          type: string
          x-versionadded: v2.33
        matrix:
          description: SHAP matrix values.
          items:
            items:
              type: number
            type: array
          type: array
          x-versionadded: v2.33
        rowIndex:
          description: The index of the data row used to compute the SHAP matrix.
          items:
            type: integer
          type: array
          x-versionadded: v2.33
      required:
      - baseValue
      - colnames
      - linkFunction
      - matrix
      - rowIndex
      type: object
    ShapMatrixListDataField:
      properties:
        datasetId:
          description: The dataset ID.
          type: string
        id:
          description: The ID of the SHAP matrix record.
          type: string
        metadata:
          $ref: '#/components/schemas/ShapMatrixMetadataField'
          description: The metadata containing SHAP matrix calculation details.
        modelId:
          description: The model ID.
          type: string
        projectId:
          description: The project ID.
          type: string
        url:
          description: The url at which you can retrieve the SHAP matrix.
          format: uri
          type: string
      required:
      - datasetId
      - id
      - metadata
      - modelId
      - projectId
      - url
      type: object
    ShapMatrixListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Array of SHAP matrix scores records.
          items:
            $ref: '#/components/schemas/ShapMatrixListDataField'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    ShapMatrixMetadataField:
      properties:
        maxNormalizedMismatch:
          description: The maximal relative normalized mismatch value.
          type: number
        mismatchRowCount:
          description: The count of rows for which additivity check failed.
          type: integer
      required:
      - maxNormalizedMismatch
      - mismatchRowCount
      type: object
    ShapMatrixRetrieveResponse:
      properties:
        columnNames:
          description: The column names for corresponding dataset & their SHAP values.
          items:
            type: string
          type: array
      required:
      - columnNames
      type: object
    ShapPreviewData:
      properties:
        previews:
          description: List of SHAP previews for each requested row.
          items:
            $ref: '#/components/schemas/ShapPreviewRow'
          type: array
          x-versionadded: v2.33
        previewsCount:
          description: The total number of previews.
          type: integer
          x-versionadded: v2.33
      required:
      - previews
      - previewsCount
      type: object
    ShapPreviewRow:
      properties:
        predictionValue:
          description: The prediction value for this row.
          type: number
          x-versionadded: v2.33
        previewValues:
          description: The SHAP preview values for this row.
          items:
            $ref: '#/components/schemas/ShapPreviewValue'
          type: array
          x-versionadded: v2.33
        rowIndex:
          description: The index of this row.
          minimum: 0
          type: integer
          x-versionadded: v2.33
        totalPreviewFeatures:
          description: The total number of features available after name filters have
            been applied.
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - predictionValue
      - previewValues
      - rowIndex
      - totalPreviewFeatures
      type: object
    ShapPreviewValue:
      properties:
        featureName:
          description: The name of the feature.
          type: string
          x-versionadded: v2.33
        featureRank:
          description: The SHAP value rank of the feature for this row.
          exclusiveMinimum: true
          minimum: 0
          type: integer
          x-versionadded: v2.33
        featureValue:
          description: The value of the feature for this row.
          type: string
          x-versionadded: v2.33
        hasTextExplanations:
          description: Whether the feature has text explanations available for this
            row.
          type: boolean
          x-versionadded: v2.33
        shapValue:
          description: The SHAP value of the feature for this row.
          type: number
          x-versionadded: v2.33
        textExplanations:
          description: List of the text explanations for the feature for this row.
          items:
            type: string
          type: array
          x-versionadded: v2.33
      required:
      - featureName
      - featureRank
      - featureValue
      - hasTextExplanations
      - shapValue
      - textExplanations
      type: object
    ShapWarning:
      properties:
        partitionName:
          description: The partition used for the prediction record.
          type: string
        value:
          $ref: '#/components/schemas/ShapWarningItems'
          description: The warnings related to this partition
      required:
      - partitionName
      - value
      type: object
    ShapWarningItems:
      properties:
        maxNormalizedMismatch:
          description: The maximal relative normalized mismatch value
          type: number
        mismatchRowCount:
          description: The count of rows for which additivity check failed
          type: integer
      required:
      - maxNormalizedMismatch
      - mismatchRowCount
      type: object
    ShapWarningValues:
      properties:
        maxNormalizedMismatch:
          description: The maximal relative normalized mismatch value.
          type: number
        mismatchRowCount:
          description: The count of rows for which additivity check failed.
          type: integer
      required:
      - maxNormalizedMismatch
      - mismatchRowCount
      type: object
    ShapWarnings:
      properties:
        maxNormalizedMismatch:
          description: The maximal relative normalized mismatch value.
          type: number
          x-versionadded: v2.21
        mismatchRowCount:
          description: The count of rows for which additivity check failed.
          type: integer
          x-versionadded: v2.21
      required:
      - maxNormalizedMismatch
      - mismatchRowCount
      type: object
    SharedRolesListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of SharedRoles objects.
          items:
            $ref: '#/components/schemas/SharedRolesResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    SharedRolesResponse:
      properties:
        canShare:
          description: True if this user can share with other users
          type: boolean
        canUseData:
          description: True if the user can view, download and process data (use to
            create projects, predictions, etc)
          type: boolean
        id:
          description: The ID of the recipient organization, group or user.
          type: string
        name:
          description: The name of the recipient organization, group or user.
          type: string
        role:
          description: The role of the org/group/user on this dataset or "NO_ROLE"
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: It describes the recipient type.
          enum:
          - user
          - group
          - organization
          type: string
        userFullName:
          description: If the recipient type is a user, the full name of the user
            if available.
          type: string
      required:
      - canShare
      - canUseData
      - id
      - name
      - role
      - shareRecipientType
      type: object
    SharedRolesUpdate:
      properties:
        operation:
          description: Name of the action being taken. The only operation is 'updateRoles'.
          enum:
          - updateRoles
          type: string
        roles:
          description: Array of GrantAccessControl objects., up to maximum 100 objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/GrantAccessControlWithUsername'
            - $ref: '#/components/schemas/GrantAccessControlWithId'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - operation
      - roles
      type: object
    SharedRolesUpdateWithGrant:
      properties:
        operation:
          description: Name of the action being taken. The only operation is 'updateRoles'.
          enum:
          - updateRoles
          type: string
        roles:
          description: An array of RoleRequest objects. May contain at most 100 such
            objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/GrantAccessControlWithUsernameWithGrant'
            - $ref: '#/components/schemas/GrantAccessControlWithIdWithGrant'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - operation
      - roles
      type: object
    SharedRolesWithGrantListResponse:
      properties:
        count:
          description: The number of items returned.
          type: integer
        data:
          description: The access control list.
          items:
            $ref: '#/components/schemas/AccessControlWithGrant'
          type: array
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
        totalCount:
          description: Total number of items matching the condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    SharingListResponse:
      properties:
        count:
          description: The number of items returned.
          type: integer
        data:
          description: The access control list.
          items:
            $ref: '#/components/schemas/AccessControl'
          type: array
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
      required:
      - count
      - data
      - next
      - previous
      type: object
    SharingListV2Response:
      properties:
        count:
          description: The number of items returned.
          type: integer
        data:
          description: The access control list.
          items:
            $ref: '#/components/schemas/AccessControlV2'
          type: array
        next:
          description: URL pointing to the next page.
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page.
          nullable: true
          type: string
        totalCount:
          description: Total number of items matching the condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    SharingUpdateOrRemove:
      properties:
        data:
          description: The role to set for the user.
          items:
            $ref: '#/components/schemas/UpdateAccessControl'
          maxItems: 100
          type: array
        includeFeatureDiscoveryEntities:
          default: false
          description: Whether to share all the related entities.
          type: boolean
          x-versionadded: v2.21
        sendNotification:
          default: true
          description: Send an email notification.
          type: boolean
          x-versionadded: v2.20
      required:
      - data
      type: object
    SharingUpdateOrRemoveWithGrant:
      properties:
        data:
          description: List of sharing roles to update.
          items:
            $ref: '#/components/schemas/UserRoleWithGrant'
          maxItems: 100
          type: array
      required:
      - data
      type: object
    SmartDownsamplingArguments:
      properties:
        method:
          description: The smart downsampling method.
          enum:
          - binary
          - zero-inflated
          type: string
          x-versionadded: v2.33
        rows:
          description: The number of sampled rows.
          minimum: 2
          type: integer
          x-versionadded: v2.33
        seed:
          default: null
          description: The starting number for the random number generator
          nullable: true
          type: integer
          x-versionadded: v2.33
      required:
      - method
      - rows
      type: object
    SnowflakeDataStreamer:
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
          x-versionadded: v2.28
        cloudStorageCredentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the cloud storage.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        cloudStorageType:
          default: s3
          description: Type name for cloud storage
          enum:
          - azure
          - gcp
          - s3
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the Snowflake data source.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: ID of the data store to connect to
            type: string
          - enum:
            - '[redacted]'
            type: string
        externalStage:
          description: External storage
          type: string
        query:
          description: 'A self-supplied SELECT statement of the dataset you wish to
            score. Helpful for supplying a more fine-grained selection of data not
            achievable through specification of "table" and/or "schema" parameters
            exclusively.If this job is executed with a job definition, then template
            variables are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        schema:
          description: The name of the specified database schema to read input data
            from.
          type: string
        table:
          description: The name of the specified database table to read input data
            from.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - snowflake
          type: string
      required:
      - dataStoreId
      - externalStage
      - type
      type: object
    SnowflakeIntake:
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
          x-versionadded: v2.28
        cloudStorageCredentialId:
          description: The ID of the credential holding information about a user with
            read access to the cloud storage.
          nullable: true
          type: string
        cloudStorageType:
          default: s3
          description: Type name for cloud storage
          enum:
          - azure
          - gcp
          - s3
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the Snowflake data source.
          nullable: true
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          type: string
        externalStage:
          description: External storage
          type: string
        query:
          description: 'A self-supplied SELECT statement of the dataset you wish to
            score. Helpful for supplying a more fine-grained selection of data not
            achievable through specification of "table" and/or "schema" parameters
            exclusively.If this job is executed with a job definition, then template
            variables are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        schema:
          description: The name of the specified database schema to read input data
            from.
          type: string
        table:
          description: The name of the specified database table to read input data
            from.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - snowflake
          type: string
      required:
      - dataStoreId
      - externalStage
      - type
      type: object
    SnowflakeKeyPairCredentials:
      properties:
        configId:
          description: The ID of the saved shared credentials. If specified, cannot
            include user, privateKeyStr or passphrase.
          type: string
        credentialType:
          description: The type of these credentials, 'snowflake_key_pair_user_account'
            here.
          enum:
          - snowflake_key_pair_user_account
          type: string
        passphrase:
          description: Optional passphrase to decrypt private key. Cannot include
            this parameter if configId is specified.
          type: string
        privateKeyStr:
          description: Private key for key pair authentication. Required if configId
            is not specified. Cannot include this parameter if configId is specified.
          type: string
        user:
          description: Username for this credential. Required if configId is not specified.
            Cannot include this parameter if configId is specified.
          type: string
      required:
      - credentialType
      type: object
    SnowflakeOutput:
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
          x-versionadded: v2.28
        cloudStorageCredentialId:
          description: The ID of the credential holding information about a user with
            write access to the cloud storage.
          nullable: true
          type: string
        cloudStorageType:
          default: s3
          description: Type name for cloud storage
          enum:
          - azure
          - gcp
          - s3
          type: string
        createTableIfNotExists:
          default: false
          description: Attempt to create the table first if no existing one is detected,
            before writing data with the strategy defined in the `statementType` parameter.
          type: boolean
          x-versionadded: v2.25
        credentialId:
          description: The ID of the credential holding information about a user with
            write access to the Snowflake data source.
          nullable: true
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          type: string
        externalStage:
          description: External storage
          type: string
        schema:
          description: The name of the specified database schema to write results
            to.
          type: string
        statementType:
          description: The statement type to use when writing the results.
          enum:
          - insert
          - create_table
          - createTable
          type: string
        table:
          description: The name of the specified database table to write results to.
          type: string
        type:
          description: Type name for this output type
          enum:
          - snowflake
          type: string
      required:
      - dataStoreId
      - externalStage
      - statementType
      - table
      - type
      type: object
    SnowflakeOutputAdaptor:
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
          x-versionadded: v2.28
        cloudStorageCredentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the cloud storage.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        cloudStorageType:
          default: s3
          description: Type name for cloud storage
          enum:
          - azure
          - gcp
          - s3
          type: string
        createTableIfNotExists:
          default: false
          description: Attempt to create the table first if no existing one is detected,
            before writing data with the strategy defined in the `statementType` parameter.
          type: boolean
          x-versionadded: v2.25
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the Snowflake data source.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: ID of the data store to connect to
            type: string
          - enum:
            - '[redacted]'
            type: string
        externalStage:
          description: External storage
          type: string
        schema:
          description: The name of the specified database schema to write results
            to.
          type: string
        statementType:
          description: The statement type to use when writing the results.
          enum:
          - insert
          - create_table
          - createTable
          type: string
        table:
          description: The name of the specified database table to write results to.
          type: string
        type:
          description: Type name for this output type
          enum:
          - snowflake
          type: string
      required:
      - dataStoreId
      - externalStage
      - statementType
      - table
      - type
      type: object
    SolutionResponse:
      properties:
        bestModel:
          description: True if this solution generates the best model.
          type: boolean
        complexity:
          description: The complexity score for this solution. Complexity score is
            a function of the mathematical operators used in the current solution.
            The complexity calculation can be tuned via model hyperparameters.
          type: integer
        error:
          description: The error for the current solution, as computed by eureqa using
            the `errorMetric` error metric. None if Eureqa model refitted existing
            solutions.
          nullable: true
          type: number
        eureqaSolutionId:
          description: The ID of the solution.
          type: string
        expression:
          description: The eureqa "solution string". This is a mathematical expression;
            human-readable but with strict syntax specifications defined by Eureqa.
          type: string
        expressionAnnotated:
          description: The `expression`, rendered with additional tags to assist in
            automatic parsing.
          type: string
      required:
      - bestModel
      - complexity
      - error
      - eureqaSolutionId
      - expression
      - expressionAnnotated
      type: object
    SpoolerChannelEventData:
      properties:
        name:
          description: Name or label of the spooler channel.
          maxLength: 512
          type: string
        type:
          description: Type of the spooler channel.
          enum:
          - asyncMemory
          - filesystem
          - kafka
          - memory
          - pubSub
          - rabbitMQ
          - sqs
          type: string
      required:
      - name
      - type
      type: object
    StageCoefficients:
      properties:
        coefficient:
          description: The corresponding value of the coefficient for that stage.
          type: number
        stage:
          description: The name of the stage.
          type: string
      required:
      - coefficient
      - stage
      type: object
    StatusListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of currently running async status jobs.
          items:
            $ref: '#/components/schemas/StatusRetrieveResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    StatusRetrieveResponse:
      properties:
        code:
          description: If no error occurred, 0.  Otherwise, may contain a status code
            reflecting the error.
          type: integer
        created:
          description: The time the status record was created.
          format: date-time
          type: string
        description:
          description: A description of the task being performed, if applicable
          nullable: true
          type: string
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        status:
          description: The status of the task.
          enum:
          - ABORTED
          - COMPLETED
          - ERROR
          - EXPIRED
          - INITIALIZED
          - RUNNING
          type: string
        statusId:
          description: The ID of the status object.
          type: string
        statusType:
          description: The type of thing being created by the Task, if applicable.
          nullable: true
          type: string
        type:
          description: The type of thing being created by the Task, if applicable.
          enum:
          - Dataset
          - Testing
          - CustomModelBlueprintBuild
          - CustomModelFeatureImpact
          - ProjectPermanentDeletion
          nullable: true
          type: string
      required:
      - code
      - created
      - description
      - message
      - status
      - statusId
      type: object
    StoredCredentials:
      properties:
        catalogVersionId:
          description: Identifier of the catalog version
          type: string
        credentialId:
          description: ID of the credentials object in credential store.Can only be
            used along with catalogVersionId.
          type: string
        url:
          description: URL that is subject to credentials.
          nullable: true
          type: string
      required:
      - credentialId
      type: object
    StringEncryption:
      properties:
        plainText:
          description: String to be encrypted. DataRobot will decrypt the string when
            needed to access data stores.
          type: string
      required:
      - plainText
      type: object
    StringEncryptionResponse:
      properties:
        cipherText:
          description: Encrypted version of plainText input.
          type: string
      required:
      - cipherText
      type: object
    SuggestedReviewersResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: List of suggested change request reviewers.
          items:
            $ref: '#/components/schemas/UserInfo'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    SummaryPermadeleteStatus:
      properties:
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        reportId:
          description: Report ID
          type: string
        status:
          description: The processing state of users perma-delete task.
          enum:
          - ABORTED
          - BLOCKED
          - COMPLETED
          - CREATED
          - ERROR
          - EXPIRED
          - INCOMPLETE
          - INITIALIZED
          - PAUSED
          - RUNNING
          type: string
      required:
      - message
      - reportId
      - status
      type: object
    SynapseDataStreamer:
      properties:
        cloudStorageCredentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the Azure credential holding information about
              a user with read access to the cloud storage.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the JDBC data source.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: ID of the data store to connect to
            type: string
          - enum:
            - '[redacted]'
            type: string
        externalDataSource:
          description: External datasource name
          type: string
        query:
          description: 'A self-supplied SELECT statement of the dataset you wish to
            score. Helpful for supplying a more fine-grained selection of data not
            achievable through specification of "table" and/or "schema" parameters
            exclusively.If this job is executed with a job definition, then template
            variables are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        schema:
          description: The name of the specified database schema to read input data
            from.
          type: string
        table:
          description: The name of the specified database table to read input data
            from.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - synapse
          type: string
      required:
      - dataStoreId
      - externalDataSource
      - type
      type: object
    SynapseIntake:
      properties:
        cloudStorageCredentialId:
          description: The ID of the Azure credential holding information about a
            user with read access to the cloud storage.
          nullable: true
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the JDBC data source.
          nullable: true
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          type: string
        externalDataSource:
          description: External datasource name
          type: string
        query:
          description: 'A self-supplied SELECT statement of the dataset you wish to
            score. Helpful for supplying a more fine-grained selection of data not
            achievable through specification of "table" and/or "schema" parameters
            exclusively.If this job is executed with a job definition, then template
            variables are available which will be substituted for timestamps: {{ current_run_timestamp
            }}, {{ last_completed_run_time }}, {{ last_scheduled_run_time }}, {{ next_scheduled_run_time
            }}, {{ current_run_time }}'
          type: string
        schema:
          description: The name of the specified database schema to read input data
            from.
          type: string
        table:
          description: The name of the specified database table to read input data
            from.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - synapse
          type: string
      required:
      - dataStoreId
      - externalDataSource
      - type
      type: object
    SynapseOutput:
      properties:
        cloudStorageCredentialId:
          description: The ID of the credential holding information about a user with
            write access to the cloud storage.
          nullable: true
          type: string
        createTableIfNotExists:
          default: false
          description: Attempt to create the table first if no existing one is detected,
            before writing data with the strategy defined in the `statementType` parameter.
          type: boolean
          x-versionadded: v2.25
        credentialId:
          description: The ID of the credential holding information about a user with
            write access to the JDBC data source.
          nullable: true
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          type: string
        externalDataSource:
          description: External data source name
          type: string
        schema:
          description: The name of the specified database schema to write results
            to.
          type: string
        statementType:
          description: The statement type to use when writing the results.
          enum:
          - insert
          - create_table
          - createTable
          type: string
        table:
          description: The name of the specified database table to write results to.
          type: string
        type:
          description: Type name for this output type
          enum:
          - synapse
          type: string
      required:
      - dataStoreId
      - externalDataSource
      - statementType
      - table
      - type
      type: object
    SynapseOutputAdaptor:
      properties:
        cloudStorageCredentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the cloud storage.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        createTableIfNotExists:
          default: false
          description: Attempt to create the table first if no existing one is detected,
            before writing data with the strategy defined in the `statementType` parameter.
          type: boolean
          x-versionadded: v2.25
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          nullable: true
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the JDBC data source.
            nullable: true
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: ID of the data store to connect to
            type: string
          - enum:
            - '[redacted]'
            type: string
        externalDataSource:
          description: External data source name
          type: string
        schema:
          description: The name of the specified database schema to write results
            to.
          type: string
        statementType:
          description: The statement type to use when writing the results.
          enum:
          - insert
          - create_table
          - createTable
          type: string
        table:
          description: The name of the specified database table to write results to.
          type: string
        type:
          description: Type name for this output type
          enum:
          - synapse
          type: string
      required:
      - dataStoreId
      - externalDataSource
      - statementType
      - table
      - type
      type: object
    TableDescription:
      properties:
        catalog:
          description: Name of the catalog.
          type: string
        name:
          description: Name of the table.
          type: string
        schema:
          description: Schema of the table.
          type: string
        type:
          description: Type of table.
          enum:
          - TABLE
          - VIEW
          type: string
      required:
      - name
      - type
      type: object
    Tableau:
      properties:
        contentUrl:
          description: Deprecated, use `siteName` instead
          type: string
        credentialId:
          description: Use the specified credential to access the url
          type: string
        dataSourceId:
          description: The ID of your Tableau data source
          type: string
        overwrite:
          description: Should the dataset be overwritten or appended to
          type: boolean
        siteName:
          description: Your Tableau site name
          type: string
        type:
          description: Type name for this output type
          enum:
          - tableau
          type: string
        url:
          description: The URL to your online Tableau server
          format: uri
          type: string
      required:
      - dataSourceId
      - overwrite
      - type
      - url
      type: object
    TableauOutputAdaptor:
      properties:
        contentUrl:
          description: Deprecated, use `siteName` instead
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: Use the specified credential to access the url
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataSourceId:
          description: The ID of your Tableau data source
          type: string
        overwrite:
          description: Should the dataset be overwritten or appended to
          type: boolean
        siteName:
          description: Your Tableau site name
          type: string
        type:
          description: Type name for this output type
          enum:
          - tableau
          type: string
        url:
          description: The URL to your online Tableau server
          format: uri
          type: string
      required:
      - dataSourceId
      - overwrite
      - type
      - url
      type: object
    TargetBaseline:
      properties:
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          nullable: true
          type: array
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          nullable: true
          type: number
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          nullable: true
          type: array
        modelId:
          description: ID of the model
          type: string
        percentiles:
          description: Predicted value or positive class predicted probability at
            specific percentiles in the bucket, only for regression and binary classification
            deployments.
          items:
            $ref: '#/components/schemas/Percentile'
          nullable: true
          type: array
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          nullable: true
          type: integer
        rowCount:
          description: Number of rows in the bucket.
          nullable: true
          type: integer
      required:
      - modelId
      - rowCount
      type: object
    TargetBin:
      properties:
        targetBinEnd:
          description: End value for the target bin
          type: number
        targetBinStart:
          description: Start value for the target bin
          type: number
      required:
      - targetBinEnd
      - targetBinStart
      type: object
    TargetDriftResponse:
      properties:
        baselineSampleSize:
          description: sample size of the training data.
          type: integer
        batchId:
          default: []
          description: The id of the batch for which metrics are being retrieved.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
        driftScore:
          description: drift score for the target.
          nullable: true
          type: number
        metric:
          description: Metric used to calculate drift score.
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          type: string
        modelId:
          description: id of the model for which data drift is being retrieved.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
          description: An object with the keys "start" and "end" defining the period.to
            retrieve features drift.
        sampleSize:
          description: number of predictions used to compute the drift score.
          type: integer
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          nullable: true
          type: string
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          nullable: true
          type: string
          x-versionadded: v2.20
        targetName:
          description: name of the target feature.
          type: string
        type:
          description: Type of the feature.
          enum:
          - numeric
          - categorical
          - text
          type: string
      required:
      - baselineSampleSize
      - driftScore
      - modelId
      - sampleSize
      - targetName
      - type
      type: object
    TargetDriftSetting:
      properties:
        enabled:
          description: Indicates whether target drift tracking is enabled for this
            deployment.
          type: boolean
      required:
      - enabled
      type: object
    TargetDriftUpdate:
      properties:
        enabled:
          description: True if target drift tracking is enabled for this deployment,
            false if otherwise.
          type: boolean
      required:
      - enabled
      type: object
    TaskPlanItem:
      properties:
        column:
          description: Column to apply transformations to.
          type: string
          x-versionadded: v2.33
        taskList:
          description: Tasks to apply to the specific column.
          items:
            $ref: '#/components/schemas/OneOfTransforms'
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - column
      - taskList
      type: object
    TemplatePermissionsResponse:
      properties:
        CAN_DELETE_TEMPLATE:
          description: Whether the current user can delete this template
          type: boolean
        CAN_EDIT_TEMPLATE:
          description: Whether the current user can edit this template
          type: boolean
        CAN_SHARE:
          description: Whether the current user can share this template
          type: boolean
        CAN_USE_TEMPLATE:
          description: Whether the current user can generate documents with this template
          type: boolean
        CAN_VIEW:
          description: Whether the current user can view this template
          type: boolean
      required:
      - CAN_DELETE_TEMPLATE
      - CAN_EDIT_TEMPLATE
      - CAN_SHARE
      - CAN_USE_TEMPLATE
      - CAN_VIEW
      type: object
    TemplateResponse:
      properties:
        creatorId:
          description: The ID of the user who created the template
          type: string
        creatorUsername:
          description: The username of the user who created the template
          type: string
        dateModified:
          description: Last date/time of template modification.
          format: date-time
          nullable: true
          type: string
        description:
          description: An overview of the template
          nullable: true
          type: string
        id:
          description: The ID of the template accessible by the user
          type: string
        instructions:
          description: Currently always returns ``null``. Maintained as a placeholder
            for future functionality.
          nullable: true
          type: string
        labels:
          description: User-added filtering labels for the template
          items:
            type: string
          nullable: true
          type: array
        name:
          description: The name of the template
          type: string
        orgId:
          description: The ID of the organization the user who created the template
            belongs to
          type: string
        permissions:
          $ref: '#/components/schemas/TemplatePermissionsResponse'
          description: The level of permissions for the user viewing this template.
        projectType:
          description: Type of project template.
          enum:
          - autoMl
          - timeSeries
          nullable: true
          type: string
        sections:
          description: 'List of section objects representing the structure of the
            document. Each section can have sub-sections that have the same schema
            as the parent section, i.e., the structure is recursive. The number of
            nested sections allowed is 5. The total number of sections allowed is
            500. '
          items:
            oneOf:
            - $ref: '#/components/schemas/SectionDataRobot'
            - $ref: '#/components/schemas/SectionUser'
            - $ref: '#/components/schemas/SectionCustom'
            - $ref: '#/components/schemas/SectionTableOfContents'
          type: array
      required:
      - creatorId
      - creatorUsername
      - dateModified
      - description
      - id
      - instructions
      - labels
      - name
      - orgId
      - permissions
      - projectType
      - sections
      type: object
    TestingStatus:
      properties:
        message:
          description: Test message.
          type: string
        status:
          description: Test status.
          enum:
          - not_tested
          - queued
          - failed
          - canceled
          - succeeded
          - in_progress
          - aborted
          - warning
          - skipped
          type: string
      required:
      - message
      - status
      type: object
    Text:
      properties:
        allData:
          $ref: '#/components/schemas/AllDataText'
          description: Statistics for all data for different feature values.
        insightName:
          description: Insight name.
          enum:
          - importantNgrams
          type: string
        perCluster:
          description: Statistic values for different feature values in this cluster.
          items:
            $ref: '#/components/schemas/PerClusterText'
          type: array
      required:
      - allData
      - insightName
      - perCluster
      type: object
    TextFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          nullable: true
          type: number
        featureName:
          description: Feature name.
          type: string
        featureType:
          description: Feature Type.
          enum:
          - text
          type: string
        insights:
          description: A list of Cluster Insights for a feature.
          items:
            $ref: '#/components/schemas/Text'
          type: array
      required:
      - featureName
      - featureType
      - insights
      type: object
    TextLine:
      properties:
        bottom:
          description: Bottom coordinate of the bounding box belonging to this text
            line in number of pixels from the top image side.
          minimum: 0
          type: integer
        left:
          description: Left coordinate of the bounding box belonging to this text
            line in number of pixels from the left image side.
          minimum: 0
          type: integer
        right:
          description: Right coordinate of the bounding box belonging to this text
            line in number of pixels from the left image side.
          minimum: 0
          type: integer
        text:
          description: The text in this text line.
          type: string
        top:
          description: Top coordinate of the bounding box belonging to this text line
            in number of pixels from the top image side.
          minimum: 0
          type: integer
      required:
      - bottom
      - left
      - right
      - text
      - top
      type: object
    TimeDelta:
      properties:
        duration:
          description: Value/size of this time delta.
          minimum: 0
          type: integer
        timeUnit:
          description: Time unit name like 'MINUTE', 'DAY', 'MONTH' etc.
          type: string
      required:
      - duration
      - timeUnit
      type: object
    TimeRange:
      properties:
        end:
          description: 'End of the period to retrieve monitoring data, defaults to
            the next top of the hour. Note: this field only accepts top of the hour
            RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
          format: date-time
          nullable: true
          type: string
        start:
          description: 'Start of the period to retrieve monitoring data, defaults
            to 7 days ago from the end of the period. Note: this field only accepts
            top of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
          format: date-time
          nullable: true
          type: string
      type: object
    TimeSeriesDirectiveArguments:
      properties:
        baselinePeriods:
          default:
          - 1
          description: Periodicities used to calculate naive target features.
          items:
            exclusiveMinimum: true
            minimum: 0
            type: integer
          maxItems: 10
          minItems: 1
          type: array
          x-versionadded: v2.33
        datetimePartitionColumn:
          description: A column, which is used to order data.
          type: string
          x-versionadded: v2.33
        forecastDistances:
          description: A list of forecast distances, how many rows to predict ahead.
          items:
            exclusiveMinimum: true
            minimum: 0
            type: integer
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
        forecastPoint:
          description: Filter output by given forecast point. Can be applied only
            at the prediction time.
          format: date-time
          type: string
          x-versionadded: v2.33
        knownInAdvanceColumns:
          default: []
          description: Columns which are known in advance.
          items:
            type: string
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        multiseriesIdColumn:
          default: null
          description: Series ID column, if present. Partition data by it.
          nullable: true
          type: string
          x-versionadded: v2.33
        rollingMedianSnowflakeUserDefinedFunction:
          default: null
          description: "To optimize rolling median calculation with snowflake,\n \
            \        pass qualified path to the UDF, as follows: \"DB_NAME.SCHEMA_NAME.FUNCTION_NAME\"\
            .\n         Contact DataRobot Support to fetch a suggested SQL function.\n\
            \         "
          nullable: true
          type: string
          x-versionadded: v2.33
        rollingMostFrequentSnowflakeUserDefinedFunction:
          default: null
          description: "To optimize rolling most frequent calculation with snowflake,\n\
            \         pass qualified path to the UDF, as follows: \"DB_NAME.SCHEMA_NAME.FUNCTION_NAME\"\
            .\n         Contact DataRobot Support to fetch a suggested SQL function.\n\
            \         "
          nullable: true
          type: string
          x-versionadded: v2.33
        targetColumn:
          description: Column to be used as a target at the modeling stage. Needed
            to generate naive features.
          type: string
          x-versionadded: v2.33
        taskPlan:
          description: Task plan to describe time series specific transformations.
          items:
            $ref: '#/components/schemas/TaskPlanItem'
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - datetimePartitionColumn
      - forecastDistances
      - targetColumn
      - taskPlan
      type: object
    TimeSeriesFeatureLogListControllerResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        featureLog:
          description: The content of the feature log.
          type: string
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalLogLines:
          description: The total number of lines in feature derivation log.
          type: integer
      required:
      - count
      - featureLog
      - next
      - previous
      - totalLogLines
      type: object
    TimeSeriesOptions:
      properties:
        calendarId:
          description: The ID of the calendar to be used in this project.
          nullable: true
          type: string
        differencingMethod:
          description: For time series projects only. Used to specify which differencing
            method to apply if the data is stationary. For classification problems
            `simple` and `seasonal` are not allowed. Parameter `periodicities` must
            be specified if `seasonal` is chosen. Defaults to `auto`.
          enum:
          - auto
          - none
          - simple
          - seasonal
          nullable: true
          type: string
        exponentiallyWeightedMovingAlpha:
          description: Discount factor (alpha) used for exponentially weighted moving
            features
          exclusiveMinimum: true
          maximum: 1.0
          minimum: 0.0
          nullable: true
          type: number
        periodicities:
          description: A list of periodicities for time series projects only. For
            classification problems periodicities are not allowed. If this is provided,
            parameter 'differencing_method' will default to 'seasonal' if not provided
            or 'auto'.
          items:
            $ref: '#/components/schemas/Periodicity'
          nullable: true
          type: array
        treatAsExponential:
          description: For time series projects only. Used to specify whether to treat
            data as exponential trend and apply transformations like log-transform.
            For classification problems `always` is not allowed. Defaults to `auto`.
          enum:
          - auto
          - never
          - always
          nullable: true
          type: string
      type: object
    TimeSeriesProperties:
      properties:
        isMostlyImputed:
          default: null
          description: Whether more than half of the rows are imputed.
          nullable: true
          type: boolean
          x-versionadded: v2.26
      required:
      - isMostlyImputed
      type: object
    TimelinessSettings:
      properties:
        enabled:
          description: Indicates if timeliness status is enabled.
          type: boolean
          x-versionadded: v2.33
        expectedFrequency:
          description: Expected frequency for receiving data as an ISO 8601 duration
            string.
          type: string
          x-versionadded: v2.33
      type: object
    TrainDatetimeFrozenModel:
      properties:
        modelId:
          description: The ID of an existing model to use as the source for the training
            parameters.
          type: string
        samplingMethod:
          description: Defines how training data is selected if subsampling is used
            (e.g., if `timeWindowSamplePct` is specified). Can be either ``random``
            or ``latest``. If omitted, defaults to ``latest`` if `trainingRowCount`
            is used and ``random`` for other cases (e.g., if `trainingDuration` or
            `useProjectSettings` is specified). May only be specified for OTV projects.
          enum:
          - random
          - latest
          type: string
        timeWindowSamplePct:
          description: An integer between 1 and 99 indicating the percentage of sampling
            within the time window. The points kept are determined by the value provided
            for the `samplingMethod` option. If specified, `trainingRowCount` may
            not be specified, and the specified model must either be a duration or
            selectedDateRange model, or one of `trainingDuration` or `trainingStartDate`
            and `trainingEndDate` must be specified.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
        trainingDuration:
          description: A duration string representing the training duration for the
            submitted model. Only one of `trainingDuration`, `trainingRowCount`, `trainingStartDate`
            and `trainingEndDate`, or `useProjectSettings` may be specified.
          format: duration
          type: string
        trainingEndDate:
          description: A datetime string representing the end date of the data to
            use for training this model. If specified, `trainingStartDate` must also
            be specified. Only one of `trainingDuration`, `trainingRowCount`, `trainingStartDate`
            and `trainingEndDate`, or `useProjectSettings` may be specified.
          format: date-time
          type: string
        trainingRowCount:
          description: The number of rows of data that should be used when training
            this model. Only one of `trainingDuration`, `trainingRowCount`, `trainingStartDate`
            and `trainingEndDate`, or `useProjectSettings` may be specified.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        trainingStartDate:
          description: A datetime string representing the start date of the data to
            use for training this model. If specified, `trainingEndDate` must also
            be specified. Only one of `trainingDuration`, `trainingRowCount`, `trainingStartDate`
            and `trainingEndDate`, or `useProjectSettings` may be specified.
          format: date-time
          type: string
        useProjectSettings:
          description: If ``True``, the model will be trained using the previously-specified
            custom backtest training settings. Only one of `trainingDuration`, `trainingRowCount`,
            `trainingStartDate` and `trainingEndDate`, or `useProjectSettings` may
            be specified.
          type: boolean
          x-versionadded: v2.24
      required:
      - modelId
      type: object
    TrainDatetimeModel:
      properties:
        blueprintId:
          description: The ID of a blueprint to use to generate the model. Allowed
            blueprints can be retrieved using :http:get:`/api/v2/projects/(projectId)/blueprints/`
            or taken from existing models.
          type: string
        featurelistId:
          description: If specified, the model will be trained using this featurelist.
            If not specified, the recommended featurelist for the specified blueprint
            will be used. If there is no recommended featurelist, the project's default
            will be used.
          type: string
        monotonicDecreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If ``null``,
            no constraints will be enforced. If omitted, the project default is used.
            May only be specified for OTV projects.
          nullable: true
          type: string
          x-versionadded: v2.18
        monotonicIncreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If ``null``,
            no constraints will be enforced. If omitted, the project default is used.
            May only be specified for OTV projects.
          nullable: true
          type: string
          x-versionadded: v2.18
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          maximum: 100
          minimum: 2
          type: integer
          x-versionadded: v2.27
        samplingMethod:
          description: Defines how training data is selected if subsampling is used
            (e.g., if `timeWindowSamplePct` is specified). Can be either ``random``
            or ``latest``. If omitted, defaults to ``latest`` if `trainingRowCount`
            is used and ``random`` for other cases (e.g., if `trainingDuration` or
            `useProjectSettings` is specified). May only be specified for OTV projects.
          enum:
          - random
          - latest
          type: string
          x-versionadded: v2.20
        sourceProjectId:
          description: The project the blueprint comes from. Required only if the
            `blueprintId` comes from a different project.
          type: string
        timeWindowSamplePct:
          description: An integer between 1 and 99 indicating the percentage of sampling
            within the time window. The points kept are determined by the value provided
            for the `samplingMethod` option. If specified, `trainingRowCount` may
            not be specified, and the specified model must either be a duration or
            selectedDateRange model, or one of `trainingDuration` or `trainingStartDate`
            and `trainingEndDate` must be specified.
          exclusiveMaximum: true
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
          x-versionadded: v2.7
        trainingDuration:
          description: A duration string representing the training duration for the
            submitted model.
          format: duration
          type: string
        trainingRowCount:
          description: The number of rows of data that should be used when training
            this model.
          exclusiveMinimum: true
          minimum: 0
          type: integer
        useProjectSettings:
          description: If ``True``, the model will be trained using the previously-specified
            custom backtest training settings.
          type: boolean
          x-versionadded: v2.19
      required:
      - blueprintId
      type: object
    TrainIncrementalLearningModel:
      properties:
        dataStageCompression:
          description: File compression for the data stage. Only supports CSV storage
            type.
          enum:
          - zip
          - bz2
          - gzip
          type: string
          x-versionadded: v2.33
        dataStageDelimiter:
          description: File delimiter for the data stage specified as a string.
          type: string
          x-versionadded: v2.33
        dataStageEncoding:
          description: File encoding for the data stage.
          enum:
          - UTF-8
          - ASCII
          - WINDOWS-1252
          type: string
          x-versionadded: v2.33
        dataStageId:
          description: Data stage ID. Data stage must be finalized and not expired.
          type: string
          x-versionadded: v2.33
        dataStageStorageType:
          default: csv
          description: File type of the data stage contents.
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.33
        modelId:
          description: Parent model ID. This model must support incremental learning.
          type: string
          x-versionadded: v2.33
        trainingDataName:
          description: String identifier for the current iteration.
          maxLength: 500
          type: string
          x-versionadded: v2.33
      required:
      - dataStageId
      - modelId
      type: object
    TrainModel:
      properties:
        blueprintId:
          description: The ID of a blueprint to use to generate the model. Allowed
            blueprints can be retrieved using :http:get:`/api/v2/projects/(projectId)/blueprints/`
            or taken from existing models.
          type: string
        featurelistId:
          description: If specified, the model will be trained using this featurelist.
            If not specified, the recommended featurelist for the specified blueprint
            will be used. If there is no recommended featurelist, the project's default
            will be used.
          type: string
        monotonicDecreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically decreasing relationship to the target. If ``null``,
            no constraints will be enforced. If omitted, the project default is used.
          nullable: true
          type: string
        monotonicIncreasingFeaturelistId:
          description: The ID of the featurelist that defines the set of features
            with a monotonically increasing relationship to the target. If ``null``,
            no constraints will be enforced. If omitted, the project default is used.
          nullable: true
          type: string
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          maximum: 100
          minimum: 2
          type: integer
          x-versionadded: v2.27
        samplePct:
          description: The percentage of the dataset to use with the model. Only one
            of `samplePct` and `trainingRowCount` should be specified. The specified
            percentage should be between 0 and 100.
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: number
        scoringType:
          description: Validation is available for any partitioning. If the project
            uses cross validation, `crossValidation` may be used to indicate that
            all available training/validation combinations should be used.
          enum:
          - validation
          - crossValidation
          type: string
        sourceProjectId:
          description: The project the blueprint comes from. Required only if the
            `blueprintId` comes from a different project.
          type: string
        trainingRowCount:
          description: An integer representing the number of rows of the dataset to
            use with the model. Only one of `samplePct` and `trainingRowCount` should
            be specified.
          type: integer
      required:
      - blueprintId
      type: object
    TrainingDataAssignmentErrorResponse:
      properties:
        message:
          description: Training data assignment error message
          maxLength: 10000
          nullable: true
          type: string
          x-versionadded: v2.31
      type: object
    TrainingDataEntry:
      properties:
        id:
          description: The ID of the AI Catalog entry.
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the AI Catalog entry.
          type: string
          x-versionadded: v2.33
      required:
      - id
      - name
      type: object
    TrainingDataExportCreatePayload:
      properties:
        modelId:
          default: null
          description: (Optional) The ID of the model.
          nullable: true
          type: string
          x-versionadded: v2.33
      type: object
    TrainingDataExportEntity:
      properties:
        createdAt:
          description: Training data export creation timestamp.
          format: date-time
          type: string
          x-versionadded: v2.33
        createdBy:
          description: The user who created training data export.
          type: string
          x-versionadded: v2.33
        data:
          $ref: '#/components/schemas/TrainingDataEntry'
          description: A training data entry.
          x-versionadded: v2.33
        id:
          description: The ID of the training data export.
          type: string
          x-versionadded: v2.33
        modelId:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        modelPackageId:
          description: The ID of the related model package.
          type: string
          x-versionadded: v2.33
      required:
      - createdAt
      - createdBy
      - data
      - id
      - modelId
      - modelPackageId
      type: object
    TrainingDataExportListResponse:
      properties:
        count:
          description: Number of paginated entries.
          minimum: 0
          type: integer
          x-versionadded: v2.33
        data:
          description: A list of training data exports.
          items:
            $ref: '#/components/schemas/TrainingDataExportEntity'
          type: array
          x-versionadded: v2.33
        next:
          description: URL to the next page, or null if there is no such page.
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL to the previous page, or null if there is no such page
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: Total number of entries.
          minimum: 0
          type: integer
          x-versionadded: v2.33
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    TrainingDataResponse:
      properties:
        assignmentError:
          $ref: '#/components/schemas/TrainingDataAssignmentErrorResponse'
          description: Training data configuration.
          nullable: true
          x-versionadded: v2.31
        assignmentInProgress:
          default: false
          description: Indicates if training data is currently being assigned to the
            custom model. Only for structured models.
          type: boolean
        datasetId:
          description: The ID of the dataset.
          nullable: true
          type: string
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          nullable: true
          type: string
        datasetVersionId:
          description: The ID of the dataset version.
          nullable: true
          type: string
      type: object
    TrainingHistoryEntry:
      properties:
        creationDate:
          description: ISO-8601 timestamp of when the project the blueprint was trained
            on was created.
          type: string
        lid:
          description: The leaderboard ID the blueprint was trained on.
          type: string
        pid:
          description: The project ID the blueprint was trained on.
          type: string
        projectModelsCount:
          description: Number of models in the project the blueprint was trained on.
          type: integer
        projectName:
          description: The project name the blueprint was trained on.
          type: string
        targetName:
          description: The target name of the project the blueprint was trained on.
          type: string
      required:
      - creationDate
      - lid
      - pid
      - projectModelsCount
      - projectName
      - targetName
      type: object
    TrainingInfoResponse:
      properties:
        holdoutTrainingDuration:
          description: the duration of the data used to train a model to score the
            holdout
          format: duration
          type: string
        holdoutTrainingEndDate:
          description: the end date of the data used to train a model to score the
            holdout
          format: date-time
          type: string
        holdoutTrainingRowCount:
          description: the number of rows used to train a model to score the holdout
          type: integer
        holdoutTrainingStartDate:
          description: the start date of data used to train a model to score the holdout
          format: date-time
          type: string
        predictionTrainingDuration:
          description: the duration of the data used to train a model to make predictions
          format: duration
          type: string
        predictionTrainingEndDate:
          description: the end date of the data used to train a model to make predictions
          format: date-time
          type: string
        predictionTrainingRowCount:
          description: the number of rows used to train a model to make predictions
          type: integer
        predictionTrainingStartDate:
          description: the start date of data used to train a model to make predictions
          format: date-time
          type: string
      required:
      - holdoutTrainingDuration
      - holdoutTrainingEndDate
      - holdoutTrainingRowCount
      - holdoutTrainingStartDate
      - predictionTrainingDuration
      - predictionTrainingEndDate
      - predictionTrainingRowCount
      - predictionTrainingStartDate
      type: object
    TrainingPredictionsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of training prediction jobs
          items:
            $ref: '#/components/schemas/TraningPredictions'
            description: A training prediction job
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    TrainingPredictionsRetrieveResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of training prediction rows
          items:
            $ref: '#/components/schemas/TraningPredictionRow'
            description: A training prediction row
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
      required:
      - data
      - next
      - previous
      type: object
    TraningPredictionRow:
      properties:
        forecastDistance:
          description: (if time series project) The number of time units this prediction
            is away from the forecastPoint. The unit of time is determined by the
            timeUnit of the datetime partition column.
          nullable: true
          type: integer
        forecastPoint:
          description: (if time series project) The forecastPoint of the predictions.
            Either provided or inferred.
          format: date-time
          nullable: true
          type: string
        partitionId:
          description: The partition used for the prediction record
          type: string
        prediction:
          description: The prediction of the model.
          oneOf:
          - description: If using a regressor model, will be the numeric value of
              the target.
            type: number
          - description: If using a binary or muliclass classifier model, will be
              the predicted class.
            type: string
          - description: If using a multilabel classifier model, will be a list of
              predicted classes.
            items:
              type: string
            type: array
        predictionExplanations:
          description: Array contains `predictionExplanation` objects. The total elements
            in the array are bounded by maxExplanations and feature count. It will
            be present only if `explanationAlgorithm` is not null (prediction explanations
            were requested).
          items:
            $ref: '#/components/schemas/PredictionExplanationsObject'
            description: Prediction explanation result.
          nullable: true
          type: array
          x-versionadded: v2.21
        predictionThreshold:
          description: Threshold used for binary classification in predictions.
          maximum: 1.0
          minimum: 0.0
          type: number
        predictionValues:
          description: A list of predicted values for this row.
          items:
            $ref: '#/components/schemas/PredictionArrayObjectValues'
            description: Predicted values
          type: array
        rowId:
          description: The row in the prediction dataset this prediction corresponds
            to.
          minimum: 0
          type: integer
        seriesId:
          description: The ID of the series value for a multiseries project. For time
            series projects that are not a multiseries this will be a NaN.
          nullable: true
          type: string
        shapMetadata:
          $ref: '#/components/schemas/TraningPredictionShapMetadata'
          description: The additional information necessary to understand shap based
            prediction explanations. Only present if explanationAlgorithm="shap" was
            added in compute request.
          nullable: true
          x-versionadded: v2.21
        timestamp:
          description: (if time series project) The timestamp of this row in the prediction
            dataset.
          format: date-time
          nullable: true
          type: string
      required:
      - partitionId
      - prediction
      - rowId
      type: object
    TraningPredictionShapMetadata:
      properties:
        shapBaseValue:
          description: The model's average prediction over the training data. SHAP
            values are deviations from the base value.
          type: number
        shapRemainingTotal:
          description: The total of SHAP values for features beyond the maxExplanations.
            This can be identically 0 in all rows, if maxExplanations is greater than
            the number of features and thus all features are returned.
          type: integer
        warnings:
          description: SHAP values calculation warnings
          items:
            $ref: '#/components/schemas/ShapWarningItems'
          type: array
      required:
      - shapBaseValue
      - shapRemainingTotal
      - warnings
      type: object
    TraningPredictions:
      properties:
        dataSubset:
          description: Subset of data predicted on
          enum:
          - all
          - validationAndHoldout
          - holdout
          - allBacktests
          - validation
          - crossValidation
          type: string
          x-enum-versionadded:
          - value: validation
            x-versionadded: v2.21
        explanationAlgorithm:
          description: The method used for calculating prediction explanations
          enum:
          - shap
          nullable: true
          type: string
          x-versionadded: v2.21
        id:
          description: ID of the training prediction job
          type: string
        maxExplanations:
          description: the number of top contributors that are included in prediction
            explanations. Defaults to null for datasets narrower than 100 columns,
            defaults to 100 for datasets wider than 100 columns
          maximum: 100
          minimum: 0
          nullable: true
          type: integer
        modelId:
          description: ID of the model
          type: string
        shapWarnings:
          description: Will be present if "explanationAlgorithm" was set to "shap"
            and there were additivity failures during SHAP values calculation
          items:
            $ref: '#/components/schemas/ShapWarning'
            description: A training prediction job
          nullable: true
          type: array
          x-versionadded: v2.21
        url:
          description: The location of these predictions
          format: uri
          type: string
      required:
      - dataSubset
      - id
      - modelId
      - url
      type: object
    Transformation:
      properties:
        enabled:
          default: false
          description: Whether this transformation is enabled by default
          type: boolean
        name:
          description: Transformation name
          type: string
        params:
          description: Config values for transformation
          items:
            $ref: '#/components/schemas/TransformationParam'
          type: array
      required:
      - name
      type: object
    TransformationParam:
      properties:
        currentValue:
          anyOf:
          - type: integer
          - type: number
          description: Current transformation value
        maxValue:
          anyOf:
          - type: integer
          - type: number
          description: Max transformation value
        minValue:
          anyOf:
          - type: integer
          - type: number
          description: Min transformation value
        name:
          description: Transformation param name
          type: string
      required:
      - name
      type: object
    Transformations:
      properties:
        name:
          description: The name of the transformation.
          type: string
        value:
          description: The value used in carrying it out.
          type: string
      required:
      - name
      - value
      type: object
    Trigger:
      properties:
        minIntervalBetweenRuns:
          description: Minimal interval between policy runs in ISO 8601 duration string.
          nullable: true
          type: string
        schedule:
          $ref: '#/components/schemas/Schedule'
          description: Crontab schedule of the retraining policy run.
        statusDeclinesToFailing:
          description: Identifies when trigger type is based on deployment a health
            status, whether the policy will run when health status declines to failing.
          type: boolean
        statusDeclinesToWarning:
          description: Identifies when trigger type is based on deployment a health
            status, whether the policy will run when health status declines to warning.
          type: boolean
        statusStillInDecline:
          description: Identifies when trigger type is based on deployment a health
            status, whether the policy will run when health status still in decline.
          nullable: true
          type: boolean
        type:
          description: Type of retraining policy trigger.
          enum:
          - schedule
          - data_drift_decline
          - accuracy_decline
          - custom_job
          - None
          type: string
      required:
      - type
      type: object
    TuningParameter:
      properties:
        parameterId:
          description: ID of the parameter whose value to set.
          type: string
        value:
          description: Value for the specified parameter.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
      required:
      - parameterId
      - value
      type: object
    TuningParameters:
      properties:
        constraints:
          $ref: '#/components/schemas/Constraints'
          description: Constraints on valid values for this parameter. Note that any
            of these fields may be omitted but at least one will always be present.
            The presence of a field indicates that the parameter in question will
            accept values in the corresponding format.
        currentValue:
          description: The single value or list of values of the parameter that were
            grid searched. Depending on the grid search specification, could be a
            single fixed value (no grid search), a list of discrete values, or a range.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
        defaultValue:
          description: The actual value used to train the model; either the single
            value of the parameter specified before training, or the best value from
            the list of grid-searched values (based on `current_value`).
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
        parameterId:
          description: Unique (per-blueprint) identifier of this parameter. This is
            the identifier used to specify which parameter to tune when make a new
            advanced tuning request.
          type: string
        parameterName:
          description: Name of the parameter.
          type: string
        taskName:
          description: Human-readable name of the task that this parameter belongs
            to.
          type: string
        vertexId:
          description: Id of the vertex this parameter belongs to.
          type: string
          x-versionadded: v2.29
      required:
      - constraints
      - currentValue
      - defaultValue
      - parameterId
      - parameterName
      - taskName
      - vertexId
      type: object
    UpdateAccessControl:
      properties:
        role:
          description: The role to set for the user.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          nullable: true
          type: string
        username:
          description: The username of the user to set the role for.
          type: string
      required:
      - role
      - username
      type: object
    UpdateCatalogMetadata:
      properties:
        description:
          description: New catalog item description
          maxLength: 1000
          type: string
        name:
          description: New catalog item name
          maxLength: 255
          type: string
        tags:
          description: New catalog item tags. Tags must be the lower case, without
            spaces,and cannot include -$.,{}"#' special characters.
          items:
            maxLength: 255
            minLength: 0
            type: string
          type: array
      type: object
    UpdateCustomJob:
      properties:
        description:
          description: The description of the custom job.
          maxLength: 10000
          type: string
          x-versionadded: v2.33
        entryPoint:
          description: The ID of the entry point file to use.
          type: string
          x-versionadded: v2.33
        environmentId:
          description: The ID of the execution environment to use for this custom
            job.
          type: string
          x-versionadded: v2.33
        environmentVersionId:
          description: The ID of the execution environment version to use for this
            custom job. If not provided, the latest execution environment version
            will be used.
          type: string
          x-versionadded: v2.33
        file:
          description: 'A file with code for a custom task or a custom model. For
            each file supplied as form data, you must have a corresponding `filePath`
            supplied that shows the relative location of the file. For example, you
            have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`.
            When uploading these files, you would _also_ need to include two `filePath`
            fields of, `"main.py"` and `"helpers/helper.py"`. If the supplied `file`
            already exists at the supplied `filePath`, the old file is replaced by
            the new file.'
          format: binary
          type: string
          x-versionadded: v2.33
        filePath:
          description: The local path of the file being uploaded. See the `file` field
            explanation for more details.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
          x-versionadded: v2.33
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
          x-versionadded: v2.33
        name:
          description: Name of the custom job.
          maxLength: 255
          type: string
          x-versionadded: v2.33
        resources:
          $ref: '#/components/schemas/CustomJobResources'
          description: The custom job resources that will be applied in the k8s cluster.
          nullable: true
          x-versionadded: v2.33
        runtimeParameterValues:
          description: Ability to inject values into a custom job at runtime. The
            fieldName must match a fieldName that is listed in the runtimeParameterDefinitions
            section of the metadata.yaml file. This list will be merged with any existing
            runtime values set from the prior version when issuing a PATCH request
            so it is possible to specify a `null` value to unset specific parameters
            and fall back to the defaultValue from the definition.
          type: string
          x-versionadded: v2.33
      type: object
    UpdateDatasetDeleted:
      type: object
    UpdateDriverRequest:
      properties:
        baseNames:
          description: Original file name(s) of the uploaded JAR file(s). If there
            are multiple JAR files required for the driver, each of the original file
            names should be present in the list in the same order as found in 'localJarUrls'
          items:
            description: Original file name of the uploaded JAR file.
            type: string
          type: array
        canonicalName:
          description: User-friendly driver name.
          type: string
        className:
          description: Driver class name. For example 'com.amazon.redshift.jdbc.Driver'
          nullable: true
          type: string
        configurationId:
          description: Driver configuration ID if it was provided during driver upload.
          nullable: true
          type: string
          x-versionadded: v2.18
        localJarUrls:
          description: File path(s) for the driver files.This path is returned in
            the response as 'local_url' by the driverUpload route.If there are multiple
            JAR files required for the driver, each uploaded JAR must be present in
            this list. If specified, values will replace any previous settings.
          items:
            description: File path for the driver file. This path is returned by the
              driverUpload route in the 'local_url' response.
            type: string
          minItems: 1
          type: array
        removeConfig:
          description: 'Pass `True` to remove configuration currently associated with
            this driver. Note: must pass `canonicalName` and `className` if removing
            the configuration.'
          type: boolean
          x-versionadded: v2.18
        skipConfigVerification:
          description: Pass `True` to skip `jdbc_url` verification.
          type: boolean
          x-versionadded: v2.18
        version:
          description: Driver version, which is used to construct the canonical name
            if driver configuration ID was provided during driver upload.
          type: string
          x-versionadded: v2.18
      type: object
    UpdateFeaturelist:
      properties:
        description:
          description: The new featurelist description.
          maxLength: 1000
          type: string
        name:
          description: The new featurelist name.
          maxLength: 100
          type: string
      type: object
    UpdateSsoConfiguration:
      properties:
        advancedConfiguration:
          $ref: '#/components/schemas/SamlAdvancedConfiguration'
          description: An object containing SSO client advanced parameters.
          nullable: true
        attributeMapping:
          $ref: '#/components/schemas/EnhancedSamlAttributeMapping'
          description: Attribute mapping between Datarobot and IdP. The dict that
            have predefined datarobot attributes in keys and idp attribute in values.
        autoGenerateUsers:
          description: determines if DataRobot automatically creates an account on
            first successful login via IdP if the user doesn't exist in the DataRobot
            application.
          type: boolean
        certificate:
          $ref: '#/components/schemas/SamlCertificate'
          description: Certificate to be used by IdP.
        configurationType:
          description: 'The type of the SSO configuration, defines the source of SSO
            metadata. It can be one of the following: `METADATA` - when IDP metadata
            is provided in the config, `METADATA_URL` - when an URL for metadata retrieval
            is provided in the config and `MANUAL` - when IDP sign-on/sign-out URLs
            and certificate are provided.'
          enum:
          - MANUAL
          - METADATA
          - METADATA_URL
          type: string
        enableSso:
          description: Defines if SSO is enabled.
          type: boolean
        enforceSso:
          description: Defines if SSO is enforced.
          type: boolean
        entityId:
          description: The globally unique identifier of the entity. Provided by IdP
            service.
          type: string
        groupMapping:
          description: The list of DataRobot group to identity provider group maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlGroupMapping'
          type: array
        idpMetadata:
          $ref: '#/components/schemas/SamlMetadataFile'
          description: XML document, IdP SSO descriptor. Provided by IdP service.
        idpMetadataHttpsVerify:
          description: When idp_metadata_url uses HTTPS, require the server to have
            a trusted certificate. To avoid security vulnerabilities, only set to
            False when a trusted server has a self-signed certificate.
          type: boolean
        idpMetadataUrl:
          description: URL to the IdP SSO descriptor. Provided by IdP service.
          format: uri
          type: string
        idpResponseMethod:
          description: Identity provider response method, used to move user from IdP's
            authentication form back to the DataRobot side.
          enum:
          - POST
          - REDIRECT
          type: string
        issuer:
          description: Optional Issuer field that may be required by IdP.
          type: string
        name:
          description: The name of the SSO configuration.
          type: string
        organizationId:
          description: The organization ID to which the SSO config belongs.
          type: string
        roleMapping:
          description: The list of DataRobot access role to identity provider role
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlRoleMapping'
          type: array
        securityParameters:
          $ref: '#/components/schemas/SamlSecurityParameters'
          description: The object that contains SAML specific directives.
        sessionLengthSeconds:
          description: Time window for the authentication session via IdP.
          type: integer
        signOnUrl:
          description: URL to sign on via SSO.
          format: uri
          type: string
        signOutUrl:
          description: URL to sign out via SSO.
          format: uri
          type: string
        spRequestMethod:
          description: Service provider (DataRobot application) request method, is
            used to move user to the IdP's authentication form.
          enum:
          - POST
          - REDIRECT
          type: string
      type: object
    UploadRatingTable:
      properties:
        parentModelId:
          description: the parent model this rating table file was derived from
          type: string
        ratingTableFile:
          description: rating table file to use for the new rating table. Accepts
            `Content-Type:multipart/form-data`
          format: binary
          type: string
        ratingTableName:
          description: the name of the new rating table to create
          type: string
      required:
      - parentModelId
      - ratingTableFile
      - ratingTableName
      type: object
    Url:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            type: array
        doSnapshot:
          default: true
          description: If true, create a snapshot dataset; if false, create a remote
            dataset. Creating snapshots from non-file sources requires an additional
            permission, `Enable Create Snapshot Data Source`.
          type: boolean
        persistDataAfterIngestion:
          description: If true, will enforce saving all data (for download and sampling)
            and will allow a user to view extended data profile (which includes data
            statistics like min/max/median/mean, histogram, etc.). If false, will
            not enforce saving data. The data schema (feature names and types) still
            will be available. Specifying this parameter to false and `doSnapshot`
            to true will result in an error.
          type: boolean
        sampleSize:
          $ref: '#/components/schemas/SampleSize'
          description: Ingest size to use during dataset registration. Default behavior
            is to ingest full dataset.
          nullable: true
          x-versionadded: v2.27
        url:
          description: The URL to download the dataset used to create the dataset
            item and version.
          format: url
          type: string
      required:
      - url
      type: object
    UsageDataEventsListResponse:
      properties:
        data:
          description: The available data event options to use in filtering.
          enum:
          - ADLS OAuth Failed
          - ADLS OAuth Token Obtained
          - ADLS OAuth Token Renewal Succeeded
          - ADLS OAuth User Login Started
          - ADLS OAuth User Login Succeeded
          - API Key Created
          - API Key Deleted
          - API Key Updated
          - Abort Autopilot
          - Access granted to a resource for a subject entity
          - Access granted to a resource referenced by an experiment container
          - Access request created
          - Access revoked to a resource for a subject entity
          - Access revoked to a resource referenced by an experiment container
          - Activate account
          - Activated On First Login
          - Actuals Uploaded
          - Add Model
          - Add New Dataset For Predictions
          - Add SAML configuration
          - Advanced Tuning Requested
          - App Config Changed
          - Approval Workflow Policy Action
          - Approval Workflow Policy Created
          - Approval Workflow Policy Deleted
          - Approval Workflow Policy Updated
          - Approve account
          - Association ID Set
          - Automated Application Access Revoked from the Group
          - Automated Application Access Revoked from the Organization
          - Automated Application Access Revoked from the User
          - Automated Application Created
          - Automated Application Deleted
          - Automated Application Domain Prefix Changed
          - Automated Application Duplicated
          - Automated Application Shared
          - Automated Application Shared with Group
          - Automated Application Shared with Organization
          - Automated Application Upgraded
          - Automated Demo Application Created
          - Automated Document Created
          - Automated Document Deleted
          - Automated Document Downloaded
          - Automated Document Previewed
          - Automated Document Requested
          - Available Forecast Points Computation Job Started
          - Base Image Built
          - Batch Monitoring Disabled
          - Batch Monitoring Enabled
          - Batch Prediction Created from Dataset
          - Batch prediction job aborted
          - Batch prediction job completed
          - Batch prediction job created
          - Batch prediction job failed
          - Batch prediction job started
          - Bias And Fairness Cross Class Calculated
          - Bias And Fairness Insights Calculated
          - Bias And Fairness Per Class Calculated
          - Bias and Fairness monitoring settings updated.
          - Bias and Fairness protected features specified.
          - Blending Models Limit Exceeded
          - Bulk Datasets Deleted
          - Bulk Datasets Tags Appended
          - CCM Balancer Terminated
          - CCM CLUSTER Reprovisioned
          - CCM Cluster Created
          - CCM Cluster Terminated
          - CCM Resource Group Created
          - Calculation of prediction intervals is requested
          - Challenger Insight Generation Started
          - Challenger Model Created
          - Challenger Model Deleted
          - Challenger Model Promoted
          - Challenger Models Disabled
          - Challenger Models Enabled
          - Change Request Cancelled
          - Change Request Created
          - Change Request Reopened
          - Change Request Resolved
          - Change Request Review Added
          - Change Request Updated
          - Change password
          - Child Entity Associated With Workspace In AI Catalog
          - Child Entity Disassociated From Workspace In AI Catalog
          - Clustering Cluster Names Updated
          - Codespace Created
          - Codespace Deleted
          - Codespace Metadata Edited
          - Codespace Session Started
          - Codespace Session Stopped
          - Comment Created
          - Comment Deleted
          - Comment Updated
          - Completed Feature Discovery Secondary Datasets
          - Completed Feature Discovery for Primary Dataset
          - Compliance Doc Deleted
          - Compliance Doc Downloaded
          - Compliance Doc Generated
          - Compliance Doc Previewed
          - Compute Cluster Added
          - Compute Cluster Deleted
          - Compute Cluster Updated
          - Compute External Insights
          - Compute Reason Codes
          - Create account
          - Created dataset from Data Engine workspace
          - Created dataset version from Data Engine workspace
          - Credential Created
          - Credential Deleted
          - Credential Updated
          - Credential Values Retrieved Based On OAuth Configuration ID
          - Custom Application Access Revoked from the Group
          - Custom Application Access Revoked from the Organization
          - Custom Application Access Revoked from the User
          - Custom Application Created
          - Custom Application Deleted
          - Custom Application Failed to Start
          - Custom Application Image Access Revoked from the Group
          - Custom Application Image Access Revoked from the Organization
          - Custom Application Image Access Revoked from the User
          - Custom Application Image Shared with Group
          - Custom Application Image Shared with Organization
          - Custom Application Image Shared with User
          - Custom Application Shared with Group
          - Custom Application Shared with Organization
          - Custom Application Shared with User
          - Custom Application Started
          - Custom Application Stopped
          - Custom Application Visited
          - Custom Application Visited by Guest
          - Custom Job Run Executed
          - Custom Metric Bulk Upload Succeeded
          - Custom Metric Creation Succeeded
          - Custom Metric Dataset Upload Succeeded
          - Custom Metric JSON Upload Succeeded
          - Custom Model Conversion Failed
          - Custom Model Conversion Files Uploaded
          - Custom Model Conversion Succeeded
          - Custom RBAC Access Role Created
          - Custom RBAC Access Role Deleted
          - Custom RBAC Access Role Updated
          - Custom Registered Model Created
          - Custom Registered Model Version Added
          - Custom Task Deploy
          - Custom Task Fit
          - Custom inference model added
          - Custom inference model assign training data request received
          - Custom inference model updated
          - Custom inference model version assign training data request received
          - Custom model item added
          - Custom task added
          - Custom task updated
          - Custom task version added
          - Data Connection Created
          - Data Connection Deleted
          - Data Connection Tested
          - Data Connection Updated
          - Data Matching ANN Index Profile Built
          - Data Matching Query Requested
          - Data Sample Queried For Wrangling
          - Data Sampled for Chunk Definition
          - Data Source is created
          - Data Sources Permadelete Executed
          - Data Sources Permadelete Failed
          - Data Sources Permadelete Submitted
          - Data Store Config Request Submitted
          - Data Stores Permadelete Executed
          - Data Stores Permadelete Failed
          - Data Stores Permadelete Submitted
          - Data engine query generator created
          - Data engine query generator deleted
          - Data engine workspace created
          - Data engine workspace deleted
          - Data engine workspace state previewed
          - Data engine workspace updated
          - Dataset Categories Modified
          - Dataset Column Aliases Modified
          - Dataset Created
          - Dataset Deleted
          - Dataset Description Modified
          - Dataset Download
          - Dataset Materialized
          - Dataset Name Modified
          - Dataset Reloaded
          - Dataset Shared
          - Dataset Sharing Removed
          - Dataset Tags Modified
          - Dataset Undeleted
          - Dataset Upload
          - Dataset Upload is Completed
          - Dataset Version Deleted
          - Dataset Version Undeleted
          - Dataset featurelist created
          - Dataset featurelist deleted
          - Dataset featurelist updated
          - Dataset for predictions with actual value column processed
          - Dataset refresh job created
          - Dataset refresh job deleted
          - Dataset refresh job updated
          - Dataset relationship created
          - Dataset relationship updated
          - Dataset transform created
          - Datasets Permadelete Executed
          - Datasets Permadelete Failed
          - Datasets Permadelete Submitted
          - Deactivate Account
          - Decision Flow Created
          - Decision Flow Model Package Created
          - Decision Flow Test Downloaded
          - Decision Flow Version Created
          - Decision Flow Version Deleted
          - Default value for Do-Not-Derive is changed
          - Delete SAML configuration
          - Deny account
          - Deploy Model To Hadoop
          - Deployment Activated
          - Deployment Actuals Export Created
          - Deployment Added
          - Deployment Deactivated
          - Deployment Deleted
          - Deployment Humility Rule Added
          - Deployment Humility Rule Deleted
          - Deployment Humility Rule Submitted
          - Deployment Humility Rule Updated
          - Deployment Humility Setting Updated
          - Deployment Monitoring Batch Created
          - Deployment Monitoring Timeliness Setting Changed
          - Deployment Permanently Erased
          - Deployment Processing Limit Interval Changed
          - Deployment Statistics Reset
          - Deployment prediction export created
          - Deployment prediction warning setting updated
          - Deployment training data export created
          - 'Detected Data Quality: Disguised Missing Values'
          - 'Detected Data Quality: Excess Zero'
          - 'Detected Data Quality: Imputation Leakage'
          - 'Detected Data Quality: Inconsistent Gaps'
          - 'Detected Data Quality: Inliers'
          - 'Detected Data Quality: Lagged Features'
          - 'Detected Data Quality: Leading or Trailing Series'
          - 'Detected Data Quality: Missing Documents'
          - 'Detected Data Quality: Missing Images'
          - 'Detected Data Quality: Multicategorical Invalid Format'
          - 'Detected Data Quality: New Series in Recent Data'
          - 'Detected Data Quality: Outliers'
          - 'Detected Data Quality: Quantile Target Sparsity'
          - 'Detected Data Quality: Quantile Target Zero Inflation'
          - 'Detected Data Quality: Target Leakage'
          - 'Detected Data Quality: Target had infrequent negative values'
          - Do-Not-Derive is used
          - Documentation Request
          - Download All Charts
          - Download Chart
          - Download Codegen
          - Download Codegen From Deployment
          - Download Deployment Chart
          - Download Model
          - Download Model Package
          - Download Model Package From Deployment
          - Download Predictions
          - Empty Catalog Item Created
          - Empty Cluster Status Created
          - Entitlement Definition Created
          - Entitlement Definition Deleted
          - Entitlement Definition Updated
          - Entitlement Set Created
          - Entitlement Set Deleted
          - Entitlement Set Updated
          - Entitlement Set Updated Entitlements
          - Entity notification channel created
          - Ephemeral Session Started
          - Ephemeral Session Stopped
          - Experiment Container Created
          - Experiment Container Dataset Registered
          - Experiment Container Dataset Unregistered
          - 'Experiment Container Deleted '
          - Experiment Container Entity Linked
          - Experiment Container Entity Migrated
          - Experiment Container Entity Moved
          - Experiment Container Entity Unlinked
          - Experiment Container Reference To Catalog Dataset Removed
          - Experiment Container Reference To Catalog Dataset Version Removed
          - Experiment Container Updated
          - External Predictions Configured
          - External Registered Model Created
          - External Registered Model Version Added
          - FEAR Predict Job Started
          - Failed Decision Flow Test
          - Feature Discovery Relationship Quality Assessment Inputs Metrics
          - Feature Discovery Relationship Quality Assessment Warnings Metrics
          - Feature Over Geo Computed
          - Finish Autopilot
          - First Login After DR Account Migration
          - General Feedback Submitted
          - Generic Custom Job Created
          - Generic Custom Job Manual Run Created
          - Generic Custom Job Scheduled Run Created
          - Geometry Over Geo Computed
          - Geospatial Feature Transform Created
          - Geospatial Primary Location Column Selected
          - Global SAML Configuration Added
          - Global SAML Configuration Deleted
          - Global SAML Configuration Updated
          - Group Members Updated
          - Group created
          - Group deleted
          - Group updated
          - Hosted Custom Metric Custom Job Created
          - Hosted Custom Metric Deployment Connection Created
          - Interaction Feature Created
          - Interaction Feature Deployment Created
          - Invitation Accepted
          - Invitation sent
          - Job definition created
          - Job definition updated
          - Login Fail
          - Login Succeeded Via Global SAML SSO
          - Login Success Via SAML SSO
          - Login Successful
          - Logout
          - MLOPS Integrations Deployment Launched
          - MLOPS Integrations Deployment Model Replaced
          - MLOPS Integrations Deployment Stopped
          - MLOPS Integrations Prediction Environment Created
          - MLOPS Integrations Prediction Environment Deleted
          - MLOps Installer Download Request Received
          - Managed Image Built
          - Model Deployment Shared
          - Model Insights Job Submitted
          - Models Starred
          - Multi-Factor Auth Disable
          - Multi-Factor Auth Enable
          - Multilabel Labelwise ROC With Missing TPR Or FPR Requested
          - Native Registered Model Created
          - Native Registered Model Version Added
          - Network Policy Created
          - Network Policy Deleted
          - Network Policy Updated
          - No predictors are left because of Do-Not-Derive
          - Non Existent Value Tracker Attachment Removed
          - Notebook Created
          - Notebook Deleted
          - Notebook Environment Variable Deleted
          - Notebook Environment Variable Edited
          - Notebook Environment Variables Created
          - Notebook Environment Variables Deleted
          - Notebook Metadata Edited
          - Notebook Revision Created
          - Notebook Revision Deleted
          - Notebook Revision Restored
          - Notebook Schedule Created
          - Notebook Schedule Deleted
          - Notebook Schedule Disabled
          - Notebook Schedule Enabled
          - Notebook Schedule Launched
          - Notebook Session Started
          - Notebook Session Stopped
          - Notification Channel Deleted
          - Notification Channel Template Created
          - Notification Channel Template Updated
          - Notification Custom Job Created
          - Notification Policy Created
          - Notification Policy Created From Template
          - Notification Policy Deleted
          - Notification Policy Template Created
          - Notification Policy Template Deleted
          - Notification Policy Template Updated
          - Notification Policy Updated
          - Notification channel created
          - Notification channel deleted
          - Notification channel updated
          - Notification policy created
          - Notification policy deleted
          - Notification policy updated
          - Number of bias mitigation jobs on Autopilot stage.
          - Online Conformal PI Calculation Requested
          - Organization Perma-Deletion Completed
          - Organization Perma-Deletion Failed
          - Organization Perma-Deletion Marked
          - Organization Perma-Deletion Requested
          - Organization Perma-Deletion Started
          - Organization Perma-Deletion Unmarked
          - Organization created
          - Organization deleted
          - Organization updated
          - Organizations Perma-Deletion Requested
          - PPS Docker Image Download Request Received
          - Period accuracy file validation failed
          - Period accuracy file validation successful
          - Period accuracy insight computed
          - Pipeline downsampling build and run started.
          - Pipeline downsampling run failed to start.
          - Predictions by Forecast Date Settings Updated
          - Prime Downloaded
          - Prime Run
          - Project Access Revoked from the Group
          - Project Access Revoked from the Organization
          - Project Access Revoked from the User
          - Project Autopilot Configured
          - Project Cloned
          - Project Created
          - Project Created from Dataset
          - Project Created from Project Export File
          - Project Created from Wrangled Dataset
          - Project Deleted
          - Project Description Updated
          - Project Exported as Project Export File
          - Project Options Retrieved
          - Project Options Updated
          - Project Permadelete Executed
          - Project Permadelete Failed
          - Project Permadelete Submitted
          - Project Renamed
          - Project Restored
          - Project Shared
          - Project Shared with Group
          - Project Shared with Organization
          - Project Target Selected
          - Published Recipe Data Uploaded
          - Rate limit user group changed
          - Recipe Access Revoked from Group
          - Recipe Access Revoked from Organization
          - Recipe Access Revoked from User
          - Recipe Created
          - Recipe Deleted
          - Recipe Published
          - Recipe Shared
          - Recipe Shared with Group
          - Recipe Shared with Organization
          - Recipe metadata updated
          - Registered Model Shared
          - Registered Model Updated
          - Registered Model Version Stage Transitioned
          - Registered Model Version Updated
          - Replaced Model
          - Request External Insights
          - Request External Insights - All Datasets
          - Request Model Insights
          - Restart Autopilot
          - Restore Reduced Features
          - Retraining Custom Job Created
          - Retraining Policy Cancelled
          - Retraining Policy Created
          - Retraining Policy Deleted
          - Retraining Policy Failed
          - Retraining Policy Started
          - Retraining Policy Succeeded
          - RuleFit Code Downloaded
          - SHAP Impact Computed
          - SHAP Matrix Computed
          - SHAP Predictions Explanations Computed
          - SHAP Predictions Explanations Preview Computed
          - SHAP Training Predictions Explanations Computed
          - Secure Configuration Created
          - Secure Configuration Deleted
          - Secure Configuration Shared
          - Secure Configuration Sharing Removed
          - Secure Configuration Values Updated
          - Segment Analysis Enabled
          - Segment Attributes Specified
          - Select Model Metric
          - ServiceUser Created
          - ServiceUser Deleted
          - ServiceUser Impersonated Token Requested
          - ServiceUser Token Requested
          - ServiceUser Updated
          - Start Autopilot
          - Successful Decision Flow Test
          - Successful Login using OIDC flow
          - Successful Login using OIDC token exchange
          - Successful Login via Google Idp
          - Target is set as Do-Not-Derive
          - Tenant Created
          - Tenant Encryption Key generated and managed by DataRobot KMS
          - Tenant Encryption Key rotated
          - Tenant Encryption Key scheduled for deletion
          - Tenant Encryption Key was set for the tenant
          - Tenant Perma-Deletion Completed
          - Tenant Perma-Deletion Failed
          - Tenant Perma-Deletion Requested
          - Tenant Perma-Deletion Started
          - Tenant Updated
          - Text prediction explanations computed
          - Train Model
          - Unsupervised Mode Started
          - Update SAML configuration
          - Update account
          - User Agreement Accepted
          - User Agreement Declined
          - User Append Columns Download With Predictions
          - User Blueprint Added To Repository
          - User Blueprint Created
          - User Blueprint Deleted
          - User Blueprint Deleted In Bulk
          - User Blueprint Description Modified
          - User Blueprint Name Modified
          - User Blueprint Retrieved
          - User Blueprint Tags Modified
          - User Blueprint Tasks Retrieved
          - User Blueprint Updated
          - User Blueprint Validated
          - User Blueprints Listed
          - User Provisioned From JWT
          - Users Perma-Deletion Canceled
          - Users Perma-Deletion Canceling
          - Users Perma-Deletion Completed
          - Users Perma-Deletion Failed
          - Users Perma-Deletion Preview Building Canceled
          - Users Perma-Deletion Preview Building Canceling
          - Users Perma-Deletion Preview Building Completed
          - Users Perma-Deletion Preview Building Failed
          - Users Perma-Deletion Preview Building Started
          - Users Perma-Deletion Preview Building Submitted
          - Users Perma-Deletion Started
          - Users Perma-Deletion Submitted
          - Value Tracker Attachment Added
          - Value Tracker Attachment Removed
          - Value Tracker Created
          - Value Tracker Stage Changed
          - Value Tracker Updated
          - Workspace Description Modified
          - Workspace Marked As Deleted In AI Catalog
          - Workspace Modified
          - Workspace Name Modified
          - Workspace Registered In AI Catalog
          - Workspace Scheduled Batch Run Failed
          - Workspace Scheduled Batch Run Started
          - Workspace Scheduled Batch Run Succeeded
          - Workspace Tags Modified
          - Workspace scheduled batch processing job created
          - Workspace scheduled batch processing job deleted
          - Workspace scheduled batch processing job updated
          - aiAPI Portal Login
          type: string
      required:
      - data
      type: object
    UsageDataExport:
      properties:
        end:
          description: The upper bound of stored events timestamp to include within
            the artifact.
          format: date-time
          nullable: true
          type: string
        include:
          description: Additional fields to be included.
          items:
            type: string
          type: array
        includeIdentifyingFields:
          default: true
          description: Indicates if identifying information like user names, project
            names, etc. should be included or not. Defaults to True.
          type: boolean
          x-versionadded: v2.17
        includeReport:
          description: The list of reports that should be generated. Will default
            to `None` if not specified.
          items:
            description: The available 'AuditReportType' enums include 'APP_USAGE',
              'ADMIN_USAGE' and 'PREDICTION_USAGE'.
            enum:
            - ADMIN_USAGE
            - APP_USAGE
            - PREDICTION_USAGE
            - SYSTEM_INFO
            type: string
          nullable: true
          type: array
          x-versionadded: v2.17
        noCache:
          description: Switches off caching.
          type: boolean
          x-versionadded: v2.20
        projectId:
          description: Only actions that are connected with the project will be retrieved.
          type: string
          x-versionadded: v2.18
        start:
          description: The lower bound of stored events timestamp to include within
            the artifact.
          format: date-time
          nullable: true
          type: string
        userId:
          description: Only actions performed by this user will be retrieved.
          type: string
          x-versionadded: v2.18
      required:
      - includeIdentifyingFields
      type: object
    UsageDataRetrieveResponse:
      properties:
        data:
          description: The requested usage artifact in .zip format.
          format: binary
          type: string
      required:
      - data
      type: object
    UseCaseCreate:
      properties:
        advancedTour:
          description: Advanced tour key.
          enum:
          - flightDelays
          - hospital
          nullable: true
          type: string
        description:
          default: null
          description: The description of the Use Case.
          maxLength: 500
          nullable: true
          type: string
        name:
          default: null
          description: The name of the Use Case.
          maxLength: 100
          nullable: true
          type: string
      type: object
    UseCaseDataListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: A list of the datasets in this Use Case
          items:
            $ref: '#/components/schemas/UseCaseDataResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseDataResponse:
      properties:
        columnCount:
          description: The number of columns in a dataset. ``null`` might be returned
            in case dataset is in running or errored state
          nullable: true
          type: integer
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the dataset or the recipe.
          x-versionadded: v2.33
        dataSourceType:
          description: The driver class type used to create the dataset if relevant.
          enum:
          - s3
          - native-s3
          - native-adls
          - adlsgen2
          - oracle
          - iris
          - exasol
          - sap
          - databricks-v1
          - bigquery-v1
          - bigquery1
          - bigquery2
          - athena2
          - athena1
          - kdb
          - treasuredata
          - elasticsearch
          - snowflake
          - mysq
          - mssql
          - postgres
          - palantirfoundry
          - teradata
          - redshift
          - unknown
          nullable: true
          type: string
          x-versionadded: v2.33
        dataType:
          description: The type of data entity.
          enum:
          - static
          - Static
          - STATIC
          - snapshot
          - Snapshot
          - SNAPSHOT
          - dynamic
          - Dynamic
          - DYNAMIC
          - wranglingRecipe
          - WranglingRecipe
          - WRANGLING_RECIPE
          - featureDiscoveryRecipe
          - FeatureDiscoveryRecipe
          - FEATURE_DISCOVERY_RECIPE
          type: string
          x-versionadded: v2.33
        datasetSize:
          description: The size of the dataset as a CSV in bytes. ``null`` might be
            returned in case dataset is in running or errored state
          nullable: true
          type: integer
          x-versionadded: v2.33
        description:
          description: The description of the dataset or recipe.
          nullable: true
          type: string
          x-versionadded: v2.33
        entityId:
          description: The primary id of the entity.
          type: string
          x-versionadded: v2.33
        entityType:
          description: The type of entity provided by the entity id.
          enum:
          - recipe
          - Recipe
          - RECIPE
          - dataset
          - Dataset
          - DATASET
          - project
          - Project
          - PROJECT
          - application
          - Application
          - APPLICATION
          type: string
          x-versionadded: v2.33
        featureDiscoveryProjectId:
          description: Related feature discovery project if this is a feature discovery
            dataset.
          nullable: true
          type: string
          x-versionadded: v2.33
        isWranglingEligible:
          description: Whether the source of the dataset can support wrangling.
          type: boolean
          x-versionadded: v2.33
        latestRecipeId:
          description: The latest recipe id linked to the dataset.
          nullable: true
          type: string
          x-versionadded: v2.33
        modifiedAt:
          description: The timestamp generated at dataset modification.
          format: date-time
          nullable: true
          type: string
          x-versionadded: v2.33
        name:
          description: The name of the dataset or recipe.
          nullable: true
          type: string
          x-versionadded: v2.33
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          nullable: true
          type: string
          x-versionadded: v2.33
        rowCount:
          description: The number of data rows in the dataset. ``null`` might be returned
            in case dataset is in running or errored state
          nullable: true
          type: integer
          x-versionadded: v2.33
      required:
      - columnCount
      - createdBy
      - dataSourceType
      - dataType
      - datasetSize
      - description
      - entityId
      - entityType
      - featureDiscoveryProjectId
      - isWranglingEligible
      - latestRecipeId
      - modifiedAt
      - name
      - processingState
      - rowCount
      type: object
    UseCaseDatasetResponse:
      properties:
        columnCount:
          description: The number of columns in a dataset. ``null`` might be returned
            in case dataset is in running or errored state
          nullable: true
          type: integer
        createdAt:
          description: The timestamp generated at dataset creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the dataset
        dataPersisted:
          description: If true, user is allowed to view extended data profile (which
            includes data statistics like min/max/median/mean, histogram, etc.) and
            download data. If false, download is not allowed and only the data schema
            (feature names and types) will be available.
          type: boolean
        dataSourceType:
          description: The type of the data source used to create the dataset if relevant.
          nullable: true
          type: string
        dataType:
          description: The type of data entity.
          enum:
          - static
          - Static
          - STATIC
          - snapshot
          - Snapshot
          - SNAPSHOT
          - dynamic
          - Dynamic
          - DYNAMIC
          - wranglingRecipe
          - WranglingRecipe
          - WRANGLING_RECIPE
          - featureDiscoveryRecipe
          - FeatureDiscoveryRecipe
          - FEATURE_DISCOVERY_RECIPE
          type: string
          x-versionadded: v2.33
        datasetId:
          description: The dataset id of the dataset.
          type: string
        datasetSize:
          description: The size of the dataset as a CSV in bytes. ``null`` might be
            returned in case dataset is in running or errored state
          nullable: true
          type: integer
        datasetSourceType:
          description: The source type of the dataset
          nullable: true
          type: string
        description:
          description: The description of the dataset.
          nullable: true
          type: string
          x-versionadded: v2.33
        featureDiscoveryProjectId:
          description: Related feature discovery project if this is a feature discovery
            dataset.
          nullable: true
          type: string
        isSnapshot:
          description: Whether the dataset is an immutable snapshot of data which
            has previously been retrieved and saved to DataRobot.
          type: boolean
        isWranglingEligible:
          description: Whether the source of the dataset can support wrangling.
          type: boolean
        latestRecipeId:
          description: The latest recipe id linked to the dataset.
          nullable: true
          type: string
        modifiedAt:
          description: The timestamp generated at dataset modification.
          format: date-time
          type: string
        modifiedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who was the last one to update the dataset
        name:
          description: The name of the dataset.
          type: string
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        referenceMetadata:
          $ref: '#/components/schemas/ExperimentContainerReferenceDatasetResponse'
          description: Metadata about the reference of the dataset in the Use Case.
        rowCount:
          description: The number of data rows in the dataset. ``null`` might be returned
            in case dataset is in running or errored state
          nullable: true
          type: integer
        versionId:
          description: The dataset version id of the latest version of the dataset.
          type: string
      required:
      - columnCount
      - createdAt
      - createdBy
      - dataPersisted
      - dataSourceType
      - dataType
      - datasetId
      - datasetSize
      - datasetSourceType
      - description
      - isSnapshot
      - isWranglingEligible
      - latestRecipeId
      - modifiedAt
      - modifiedBy
      - name
      - processingState
      - referenceMetadata
      - rowCount
      - versionId
      type: object
    UseCaseDatasetsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the datasets in the Use Case
          items:
            $ref: '#/components/schemas/UseCaseDatasetResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseDetails:
      properties:
        createdAt:
          description: Time when use-case was created
          type: string
        creatorEmail:
          description: Email of the user who created use-case
          nullable: true
          type: string
        creatorId:
          description: ID of the creator of the use-case
          type: string
        creatorName:
          description: Name of the user who created use-case
          nullable: true
          type: string
        id:
          description: ID of the associated use-case
          type: string
        name:
          description: Name of the use case at the moment of creation
          nullable: true
          type: string
      required:
      - createdAt
      - creatorId
      - id
      type: object
    UseCaseInfo:
      properties:
        id:
          description: ID of the Use Case this modeling project is attached to
          type: string
        name:
          description: Name of the Use Case this modeling project is attached to
          type: string
      required:
      - id
      - name
      type: object
    UseCaseLastActivity:
      properties:
        timestamp:
          description: Time when this activity occurred.
          format: date-time
          type: string
        type:
          description: The type of activity. Can be "Added" or "Modified"
          type: string
      required:
      - timestamp
      - type
      type: object
    UseCaseListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of Use Cases that match the query
          items:
            $ref: '#/components/schemas/UseCaseResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseMemberResponse:
      properties:
        email:
          description: The email address of the member.
          nullable: true
          type: string
        fullName:
          description: The full name of the member.
          nullable: true
          type: string
        id:
          description: The id of the member.
          type: string
        isOrganization:
          description: Whether the member is organization.
          nullable: true
          type: boolean
        userhash:
          description: Member's gravatar hash.
          nullable: true
          type: string
        username:
          description: The username of the member.
          nullable: true
          type: string
      required:
      - email
      - id
      type: object
    UseCaseModelsForComparisonListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: Models from multiple projects in the Use Case
          items:
            $ref: '#/components/schemas/ExperimentContainerModelsForComparisonModelResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseProjectOptionsResponse:
      properties:
        target:
          description: Name of the target
          nullable: true
          type: string
        targetType:
          description: The target type of the project.
          enum:
          - Binary
          - Regression
          - Multiclass
          - minInflated
          - Multilabel
          - TextGeneration
          nullable: true
          type: string
        weight:
          description: Name of the weight (if configured)
          nullable: true
          type: string
      type: object
    UseCaseProjectResponse:
      properties:
        autopilotDataSelectionMethod:
          description: The Data Selection method of the datetime-partitioned project.
            `null` if project is not datetime-partitioned.
          enum:
          - duration
          - rowCount
          nullable: true
          type: string
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the project
        createdAt:
          description: The timestamp generated at project creation.
          format: date-time
          type: string
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        dataset:
          description: Name of the dataset in the registry used to build the project
            associated with the project
          type: string
        datasetId:
          description: The dataset id of the dataset in the registry.
          nullable: true
          type: string
        hasHoldout:
          description: Whether the project has holdout.
          type: boolean
        isDatasetLinkedToUseCase:
          description: Indicates whether the dataset that this project was created
            from is attached to this Use Case.
          type: boolean
        isDraft:
          description: Indicates whether the experiment configuration has been used
            for modeling and is therefore locked (False) or whether the setup has
            not been applied , and as a draft, can still be modified and used in training
            (True).
          type: boolean
        isErrored:
          description: Indicates whether the experiment failed.
          type: boolean
        isScoringAvailableForModelsTrainedIntoValidationHoldout:
          description: Indicates whether validation scores are available. A result
            of 'N/A' in the UI indicates that a model was trained into validation
            or holdout and also either does not have stacked predictions or uses extended
            multiclass.
          type: boolean
        isWorkbenchEligible:
          description: Indicates whether the experiment is Workbench-compatible.
          type: boolean
        lastActivity:
          $ref: '#/components/schemas/ExperimentContainerLastActivity'
          description: Last activity details
        metricDetail:
          description: Project metrics
          items:
            $ref: '#/components/schemas/MetricDetail'
          type: array
        models:
          description: The number of models in an use case.
          type: integer
        name:
          description: The name of the project.
          type: string
        numberOfBacktests:
          description: The number of backtests of the datetime-partitioned project.
            0 if project is not datetime-partitioned.
          minimum: 0
          type: integer
        projectId:
          description: The ID of the project.
          type: string
        projectOptions:
          $ref: '#/components/schemas/UseCaseProjectOptionsResponse'
          description: Project options currently saved for a project. Can be changed
            while project is in draft status.
        statusErrorMessage:
          description: Experiment failure explanation.
          type: string
        target:
          description: Name of the target
          nullable: true
          type: string
        targetType:
          description: Type of modeling target
          enum:
          - Binary
          - Regression
          - Multiclass
          - minInflated
          - Multilabel
          - TextGeneration
          nullable: true
          type: string
        timeAware:
          description: Shows if project uses time series
          type: boolean
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who was the last one to update the project
        updatedAt:
          description: The timestamp generated at project modification.
          format: date-time
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
      required:
      - autopilotDataSelectionMethod
      - created
      - createdAt
      - dataset
      - datasetId
      - hasHoldout
      - isDatasetLinkedToUseCase
      - isDraft
      - isErrored
      - isScoringAvailableForModelsTrainedIntoValidationHoldout
      - isWorkbenchEligible
      - lastActivity
      - metricDetail
      - models
      - name
      - numberOfBacktests
      - projectId
      - projectOptions
      - statusErrorMessage
      - timeAware
      - updated
      - updatedAt
      type: object
    UseCaseProjectsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the Use Case projects that match the query
          items:
            $ref: '#/components/schemas/UseCaseProjectResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseRecentAssetsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: A list of the Use Case references that match the query.
          items:
            $ref: '#/components/schemas/UseCaseReferenceRetrieve'
          type: array
          x-versionadded: v2.33
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
          x-versionadded: v2.33
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseReferenceDatasetMetadata:
      properties:
        dataSourceType:
          description: The type of the data source used to create the dataset if relevant.
          nullable: true
          type: string
        datasetSourceType:
          description: The source type of the dataset
          nullable: true
          type: string
        isSnapshot:
          description: Whether the dataset is an immutable snapshot of data which
            has previously been retrieved and saved to DataRobot.
          type: boolean
        isWranglingEligible:
          description: Whether the source of the dataset can support wrangling.
          type: boolean
        latestRecipeId:
          description: Latest recipe ID linked to the dataset
          nullable: true
          type: string
      required:
      - dataSourceType
      - datasetSourceType
      - isSnapshot
      - isWranglingEligible
      - latestRecipeId
      type: object
    UseCaseReferenceLink:
      properties:
        workflow:
          default: unspecified
          description: The workflow that is attaching this entity. Does not affect
            the operation of the API call. Only used for analytics.
          enum:
          - migration
          - creation
          - move
          - unspecified
          type: string
      required:
      - workflow
      type: object
    UseCaseReferenceListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the Use Case references that match the query.
          items:
            $ref: '#/components/schemas/UseCaseReferenceRetrieve'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseReferenceMultilink:
      properties:
        entitiesList:
          description: Entities to link to this Use Case
          items:
            $ref: '#/components/schemas/UseCaseReferenceMultilinkEntity'
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
        workflow:
          default: unspecified
          description: The workflow that is attaching this entity. Does not affect
            the operation of the API call. Only used for analytics.
          enum:
          - migration
          - creation
          - move
          - unspecified
          type: string
          x-versionadded: v2.33
      required:
      - entitiesList
      - workflow
      type: object
    UseCaseReferenceMultilinkEntity:
      properties:
        entityId:
          description: The primary id of the entity to link.
          type: string
          x-versionadded: v2.33
        entityType:
          description: The type of entity to link.
          enum:
          - project
          - dataset
          - notebook
          - application
          - recipe
          type: string
          x-versionadded: v2.33
      required:
      - entityId
      - entityType
      type: object
    UseCaseReferencePlaygroundMetadata:
      properties:
        description:
          description: Description of the playground
          type: string
      required:
      - description
      type: object
    UseCaseReferenceProjectMetadata:
      properties:
        isDraft:
          description: Indicates whether the experiment configuration has been used
            for modeling and is therefore locked (False) or whether the setup has
            not been applied , and as a draft, can still be modified and used in training
            (True).
          type: boolean
        isErrored:
          description: Indicates whether the experiment failed.
          type: boolean
        isWorkbenchEligible:
          description: Indicates whether the experiment is Workbench-compatible.
          type: boolean
        statusErrorMessage:
          description: Experiment failure explanation.
          type: string
      required:
      - isDraft
      - isErrored
      - isWorkbenchEligible
      - statusErrorMessage
      type: object
    UseCaseReferenceRecipeMetadata:
      properties:
        dataType:
          description: The type of the recipe (wrangling or feature discovery)
          enum:
          - static
          - Static
          - STATIC
          - snapshot
          - Snapshot
          - SNAPSHOT
          - dynamic
          - Dynamic
          - DYNAMIC
          - wranglingRecipe
          - WranglingRecipe
          - WRANGLING_RECIPE
          - featureDiscoveryRecipe
          - FeatureDiscoveryRecipe
          - FEATURE_DISCOVERY_RECIPE
          nullable: true
          type: string
      required:
      - dataType
      type: object
    UseCaseReferenceRetrieve:
      properties:
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        entityId:
          description: The primary id of the entity.
          type: string
        entityType:
          description: The type of entity provided by the entity id.
          type: string
        id:
          description: The ID of the Use Case reference.
          type: string
        lastActivity:
          $ref: '#/components/schemas/UseCaseLastActivity'
          description: Last activity details
        metadata:
          description: Reference metadata for the Use Case
          oneOf:
          - $ref: '#/components/schemas/UseCaseReferenceProjectMetadata'
          - $ref: '#/components/schemas/UseCaseReferenceDatasetMetadata'
          - $ref: '#/components/schemas/UseCaseReferenceRecipeMetadata'
          - $ref: '#/components/schemas/UseCaseReferencePlaygroundMetadata'
        name:
          description: The name of the Use Case reference.
          type: string
        processingState:
          description: Current ingestion process state of dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who was the last one to update the Use Case
        updatedAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
        useCaseId:
          description: The ID of the linked Use Case.
          type: string
        useCaseName:
          description: The name of the linked Use Case.
          nullable: true
          type: string
      required:
      - entityId
      - entityType
      - id
      - lastActivity
      - name
      - updated
      - updatedAt
      - useCaseId
      type: object
    UseCaseResponse:
      properties:
        advancedTour:
          description: Advanced tour key.
          nullable: true
          type: string
        applicationsCount:
          description: The number of applications in a Use Case.
          type: integer
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who created the Use Case
        createdAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        createdBy:
          description: The id of the user who created.
          nullable: true
          type: string
        datasetsCount:
          description: The number of datasets in a Use Case.
          type: integer
        description:
          description: The description of the Use Case.
          nullable: true
          type: string
        id:
          description: The ID of the Use Case.
          type: string
        members:
          description: List of Use Case members
          items:
            $ref: '#/components/schemas/UseCaseMemberResponse'
          type: array
        modelsCount:
          description: The number of models in a Use Case.
          type: integer
        name:
          description: The name of the Use Case.
          type: string
        notebooksCount:
          description: The number of notebooks in a Use Case.
          type: integer
        owners:
          description: List of owners of a Use Case
          items:
            $ref: '#/components/schemas/UseCaseMemberResponse'
          type: array
        projectsCount:
          description: The number of projects in a Use Case.
          type: integer
        recipesCount:
          description: The number of recipes in a Use Case.
          type: integer
          x-versionadded: v2.33
        role:
          description: The requesting user's role on this Use Case.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          type: string
        tenantId:
          description: The id of the tenant to associate this organization with.
          nullable: true
          type: string
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          description: User who was the last one to update the Use Case
        updatedAt:
          description: The timestamp generated when the record was last updated.
          format: date-time
          type: string
        updatedBy:
          description: The id of the user who last updated.
          nullable: true
          type: string
      required:
      - applicationsCount
      - created
      - createdAt
      - datasetsCount
      - description
      - id
      - members
      - modelsCount
      - name
      - notebooksCount
      - projectsCount
      - recipesCount
      - role
      - tenantId
      - updated
      - updatedAt
      type: object
    UseCaseUpdate:
      properties:
        description:
          description: The description of the Use Case.
          maxLength: 500
          nullable: true
          type: string
        name:
          description: The name of the Use Case.
          maxLength: 100
          nullable: true
          type: string
      type: object
    UseCasesApplicationsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the applications in this Use Case
          items:
            $ref: '#/components/schemas/ExperimentContainerApplicationResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCasesNotebooksListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the notebooks in this Use Case
          items:
            $ref: '#/components/schemas/ExperimentContainerNotebookResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCasesPlaygroundsListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the playgrounds in this Use Case
          items:
            $ref: '#/components/schemas/ExperimentContainerPlaygroundResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCasesVectorDatabasesListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of the vector databases in this Use Case
          items:
            $ref: '#/components/schemas/ExperimentContainerVectorDatabaseResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UserBlueprintAddToMenu:
      properties:
        deleteAfter:
          default: false
          description: Whether to delete the user blueprint(s) after adding it (them)
            to the project menu.
          type: boolean
        describeFailures:
          default: false
          description: Whether to include extra fields to describe why any blueprints
            were not added to the chosen project.
          type: boolean
          x-versionadded: v2.27
        projectId:
          description: The projectId of the project for the repository to add the
            specified user blueprints to.
          type: string
        userBlueprintIds:
          description: The ids of the user blueprints to add to the specified project's
            repository.
          items:
            description: An id of one user blueprint to add to the specified project's
              repository.
            type: string
          type: array
      required:
      - deleteAfter
      - describeFailures
      - projectId
      - userBlueprintIds
      type: object
    UserBlueprintAddToMenuResponse:
      properties:
        addedToMenu:
          description: The list of userBlueprintId and blueprintId pairs representing
            blueprints successfully added to the project repository.
          items:
            $ref: '#/components/schemas/UserBlueprintAddedToMenuItem'
          type: array
        message:
          description: A success message or a list of reasons why the list of blueprints
            could not be added to the project repository.
          type: string
          x-versionadded: '2.27'
        notAddedToMenu:
          description: The list of userBlueprintId and error message representing
            blueprints which failed to be added to the project repository.
          items:
            $ref: '#/components/schemas/UserBlueprintFailedToAddToMenuItem'
          type: array
          x-versionadded: '2.27'
      required:
      - addedToMenu
      type: object
    UserBlueprintAddedToMenuItem:
      properties:
        blueprintId:
          description: The blueprintId representing the blueprint which was added
            to the project repository.
          type: string
        userBlueprintId:
          description: The userBlueprintId associated with the blueprintId added to
            the project repository.
          type: string
      required:
      - blueprintId
      - userBlueprintId
      type: object
    UserBlueprintBulkValidationRequest:
      properties:
        projectId:
          description: String representation of ObjectId for the currently active
            project. The user blueprint is validated when this project is active.
            Necessary in the event of project specific tasks, such as column selection
            tasks.
          type: string
        userBlueprintIds:
          description: The ids of the user blueprints to validate in bulk.
          items:
            description: An id of one user blueprint to validate.
            type: string
          type: array
      required:
      - userBlueprintIds
      type: object
    UserBlueprintCreate:
      properties:
        blueprint:
          description: The representation of a directed acyclic graph defining a pipeline
            of data through tasks and a final estimator.
          oneOf:
          - description: The representation of a directed acyclic graph defining a
              pipeline of data through tasks and a final estimator.
            items:
              $ref: '#/components/schemas/UserBlueprintsBlueprintTask'
            type: array
          - $ref: '#/components/schemas/AllowExtra'
            description: The compressed and legacy representation of the blueprint.
        decompressedBlueprint:
          default: false
          description: Whether to retrieve the blueprint in the decompressed format.
          type: boolean
        description:
          description: The description to give to the blueprint.
          type: string
        getDynamicLabels:
          default: false
          description: Whether to add dynamic labels to a decompressed blueprint.
          type: boolean
        isInplaceEditor:
          default: false
          description: Whether the request is sent from the in place user BP editor.
          type: boolean
        modelType:
          description: The title to give to the blueprint.
          type: string
        projectId:
          description: String representation of ObjectId for the currently active
            project. The user blueprint is created when this project is active. Necessary
            in the event of project specific tasks, such as column selection tasks.
          nullable: true
          type: string
        saveToCatalog:
          default: true
          description: Whether to save the blueprint to the catalog.
          type: boolean
      required:
      - blueprint
      - decompressedBlueprint
      - isInplaceEditor
      - saveToCatalog
      type: object
    UserBlueprintCreateFromBlueprintId:
      properties:
        blueprintId:
          description: The id associated with the blueprint to create the user blueprint
            from.
          type: string
        decompressedBlueprint:
          default: false
          description: Whether to retrieve the blueprint in the decompressed format.
          type: boolean
        description:
          description: The description to give to the blueprint.
          type: string
        getDynamicLabels:
          default: false
          description: Whether to add dynamic labels to a decompressed blueprint.
          type: boolean
        isInplaceEditor:
          default: false
          description: Whether the request is sent from the in place user BP editor.
          type: boolean
        modelType:
          description: The title to give to the blueprint.
          type: string
        projectId:
          description: String representation of ObjectId for the currently active
            project. The user blueprint is created when this project is active.
          type: string
        saveToCatalog:
          default: true
          description: Whether to save the blueprint to the catalog.
          type: boolean
      required:
      - blueprintId
      - decompressedBlueprint
      - isInplaceEditor
      - projectId
      - saveToCatalog
      type: object
    UserBlueprintCreateFromCustomTaskVersionIdPayload:
      properties:
        customTaskVersionId:
          description: The ID of a custom task version.
          type: string
        decompressedBlueprint:
          default: false
          description: Whether to retrieve the blueprint in the decompressed format.
          type: boolean
        description:
          description: The description for the user blueprint that will be created
            from this CustomTaskVersion.
          type: string
        saveToCatalog:
          default: true
          description: Whether to save the blueprint to the catalog.
          type: boolean
      required:
      - customTaskVersionId
      - decompressedBlueprint
      - saveToCatalog
      type: object
    UserBlueprintCreateFromUserBlueprintId:
      properties:
        decompressedBlueprint:
          default: false
          description: Whether to retrieve the blueprint in the decompressed format.
          type: boolean
        description:
          description: The description to give to the blueprint.
          type: string
        getDynamicLabels:
          default: false
          description: Whether to add dynamic labels to a decompressed blueprint.
          type: boolean
        isInplaceEditor:
          default: false
          description: Whether the request is sent from the in place user BP editor.
          type: boolean
        modelType:
          description: The title to give to the blueprint.
          type: string
        projectId:
          description: String representation of ObjectId for the currently active
            project. The user blueprint is created when this project is active. Necessary
            in the event of project specific tasks, such as column selection tasks.
          nullable: true
          type: string
        saveToCatalog:
          default: true
          description: Whether to save the blueprint to the catalog.
          type: boolean
        userBlueprintId:
          description: The id of the existing user blueprint to copy.
          type: string
      required:
      - decompressedBlueprint
      - isInplaceEditor
      - saveToCatalog
      - userBlueprintId
      type: object
    UserBlueprintFailedToAddToMenuItem:
      properties:
        error:
          description: The error message representing why the blueprint was not added
            to the project repository.
          type: string
        userBlueprintId:
          description: The userBlueprintId associated with the blueprint which was
            not added to the project repository.
          type: string
      required:
      - error
      - userBlueprintId
      type: object
    UserBlueprintSharedRolesListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: A list of SharedRoles objects.
          items:
            $ref: '#/components/schemas/UserBlueprintSharedRolesResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UserBlueprintSharedRolesResponse:
      properties:
        id:
          description: The ID of the recipient organization, group or user.
          type: string
        name:
          description: The name of the recipient organization, group or user.
          type: string
        role:
          description: The role of the org/group/user on this dataset or "NO_ROLE"
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
    UserBlueprintTask:
      properties:
        arguments:
          description: A list of definitions of each argument which can be set for
            the task.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskArgument'
          type: array
        categories:
          description: The categories which the task is in.
          items:
            type: string
          type: array
        colnamesAndTypes:
          description: The column names, their types, and their hex representation,
            available in the specified project for the task.
          items:
            $ref: '#/components/schemas/ColnameAndType'
          nullable: true
          type: array
        customTaskId:
          description: The id of the custom task, if it is a custom task.
          nullable: true
          type: string
        customTaskVersions:
          description: Metadata for all of the custom task's versions.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskCustomTaskMetadataWithArguments'
          nullable: true
          type: array
        description:
          description: A description of the task.
          type: string
        icon:
          description: The integer representing the id to be displayed when the blueprint
            is trained.
          type: integer
        isCommonTask:
          default: false
          description: Whether the task is a common task.
          type: boolean
        isCustomTask:
          description: Whether the task is custom code written by the user.
          type: boolean
        isVisibleInComposableMl:
          default: true
          description: Whether the task is visible in the ComposableML menu
          type: boolean
        label:
          description: The generic / default title or label for the task.
          type: string
        outputMethods:
          description: The methods which the task can use to produce output.
          items:
            type: string
          type: array
        supportsScoringCode:
          description: Whether the task supports Scoring Code.
          type: boolean
        taskCode:
          description: The unique code which represents the task to be constructed
            and executed
          type: string
        timeSeriesOnly:
          description: Whether the task can only be used with time series projects.
          type: boolean
        url:
          description: The URL of the documentation of the task.
          oneOf:
          - $ref: '#/components/schemas/AllowExtra'
          - type: string
        validInputs:
          description: The supported input types of the task.
          items:
            description: A specific supported input type.
            type: string
          type: array
      required:
      - arguments
      - categories
      - description
      - icon
      - label
      - outputMethods
      - supportsScoringCode
      - taskCode
      - timeSeriesOnly
      - url
      - validInputs
      type: object
    UserBlueprintTaskArgument:
      properties:
        argument:
          description: The definition of a task argument, used to specify a certain
            aspect of the task.
          oneOf:
          - $ref: '#/components/schemas/UserBlueprintTaskArgumentDefinition'
        key:
          description: The unique key of the argument
          type: string
      required:
      - argument
      - key
      type: object
    UserBlueprintTaskArgumentDefinition:
      properties:
        default:
          description: The default value of the argument.
          nullable: true
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
        name:
          description: The name of the argument.
          type: string
        recommended:
          description: The recommended value, based on frequently used values.
          nullable: true
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
        tunable:
          description: Whether the argument is tunable by the end-user.
          type: boolean
        type:
          description: The type of the argument (e.g. "int", "float", "select", "intgrid",
            "multi", etc.)
          type: string
        values:
          description: The possible values of the argument, which may be a range or
            list, or dictionary of ranges or lists keyed by type.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
          - $ref: '#/components/schemas/AllowExtra'
      required:
      - name
      - type
      - values
      type: object
    UserBlueprintTaskCategoryItem:
      properties:
        name:
          description: The name of the category.
          type: string
        subcategories:
          description: A list of the available task category items.
          items:
            $ref: '#/components/schemas/AllowExtra'
            description: A category name and the definitions of the tasks in the category.
          type: array
        taskCodes:
          description: A list of task codes representing the tasks in this category.
          items:
            type: string
          type: array
      required:
      - name
      - taskCodes
      type: object
    UserBlueprintTaskCustomTaskMetadataWithArguments:
      properties:
        id:
          description: Id of the custom task version. The ID can be latest_<task_id>
            which implies to use the latest version of that custom task.
          type: string
        label:
          description: The name of the custom task version.
          type: string
        versionMajor:
          description: Major version of the custom task.
          type: integer
        versionMinor:
          description: Minor version of the custom task.
          type: integer
      required:
      - id
      - label
      - versionMajor
      - versionMinor
      type: object
    UserBlueprintTaskLookupEntry:
      properties:
        taskCode:
          description: The unique code which represents the task to be constructed
            and executed
          type: string
        taskDefinition:
          description: A definition of a task in terms of label, arguments, description,
            and other metadata.
          oneOf:
          - $ref: '#/components/schemas/UserBlueprintTask'
      required:
      - taskCode
      - taskDefinition
      type: object
    UserBlueprintTaskParameterValidation:
      properties:
        outputMethod:
          description: The method representing how the task will output data.
          enum:
          - P
          - Pm
          - S
          - Sm
          - T
          - TS
          type: string
        projectId:
          description: The projectId representing the project where this user blueprint
            is edited.
          nullable: true
          type: string
        taskCode:
          description: The task code representing the task to validate parameter values.
          type: string
        taskParameters:
          description: A list of task parameters and proposed values to be validated.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskParameterValidationRequestParamItem'
          type: array
      required:
      - outputMethod
      - taskCode
      - taskParameters
      type: object
    UserBlueprintTaskParameterValidationRequestParamItem:
      properties:
        newValue:
          description: The proposed value for the task parameter.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
        paramName:
          description: The name of the task parameter to be validated.
          type: string
      required:
      - newValue
      - paramName
      type: object
    UserBlueprintTasksResponse:
      properties:
        categories:
          description: A list of the available task categories, sub-categories, and
            tasks.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskCategoryItem'
          type: array
        tasks:
          description: A list of task codes and their task definitions.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskLookupEntry'
          type: array
      required:
      - categories
      - tasks
      type: object
    UserBlueprintUpdate:
      properties:
        blueprint:
          description: The representation of a directed acyclic graph defining a pipeline
            of data through tasks and a final estimator.
          oneOf:
          - description: The representation of a directed acyclic graph defining a
              pipeline of data through tasks and a final estimator.
            items:
              $ref: '#/components/schemas/UserBlueprintsBlueprintTask'
            type: array
          - $ref: '#/components/schemas/AllowExtra'
            description: The compressed and legacy representation of the blueprint.
        decompressedBlueprint:
          default: false
          description: Whether to retrieve the blueprint in the decompressed format.
          type: boolean
        description:
          description: The description to give to the blueprint.
          type: string
        getDynamicLabels:
          default: false
          description: Whether to add dynamic labels to a decompressed blueprint.
          type: boolean
        isInplaceEditor:
          default: false
          description: Whether the request is sent from the in place user BP editor.
          type: boolean
        modelType:
          description: The title to give to the blueprint.
          type: string
        projectId:
          description: String representation of ObjectId for the currently active
            project. The user blueprint is created when this project is active. Necessary
            in the event of project specific tasks, such as column selection tasks.
          nullable: true
          type: string
        saveToCatalog:
          default: true
          description: Whether to save the blueprint to the catalog.
          type: boolean
      required:
      - decompressedBlueprint
      - isInplaceEditor
      - saveToCatalog
      type: object
    UserBlueprintValidation:
      properties:
        blueprint:
          description: The representation of a directed acyclic graph defining a pipeline
            of data through tasks and a final estimator.
          oneOf:
          - description: The representation of a directed acyclic graph defining a
              pipeline of data through tasks and a final estimator.
            items:
              $ref: '#/components/schemas/UserBlueprintsBlueprintTask'
            type: array
          - $ref: '#/components/schemas/AllowExtra'
            description: The compressed and legacy representation of the blueprint.
        isInplaceEditor:
          default: false
          description: Whether the request is sent from the in place user BP editor.
          type: boolean
        projectId:
          description: String representation of ObjectId for the currently active
            project. The user blueprint is validated when this project is active.
            Necessary in the event of project specific tasks, such as column selection
            tasks.
          nullable: true
          type: string
      required:
      - blueprint
      - isInplaceEditor
      type: object
    UserBlueprintsBlueprintTask:
      properties:
        taskData:
          description: The data defining the task / vertex in the blueprint.
          oneOf:
          - $ref: '#/components/schemas/UserBlueprintsBlueprintTaskData'
        taskId:
          description: The identifier of a task / vertex in the blueprint.
          type: string
      required:
      - taskData
      - taskId
      type: object
    UserBlueprintsBlueprintTaskData:
      properties:
        inputs:
          description: The ids or input data types which will be inputs to the task.
          items:
            description: A specific input data type
            type: string
          type: array
        outputMethod:
          description: The method which the task will use to produce output.
          type: string
        outputMethodParameters:
          default: []
          description: The parameters which further define how output will be produced.
          items:
            $ref: '#/components/schemas/ParamValuePair'
          type: array
        taskCode:
          description: The unique code representing the python class which will be
            instantiated and executed.
          nullable: true
          type: string
        taskParameters:
          default: []
          description: The parameters which further define the behavior of the task.
          items:
            $ref: '#/components/schemas/ParamValuePair'
          type: array
        xTransformations:
          default: []
          description: Transformations to apply to the input data before fitting or
            predicting.
          items:
            $ref: '#/components/schemas/ParamValuePair'
          type: array
        yTransformations:
          default: []
          description: Transformations to apply to the input target before fitting
            or predicting.
          items:
            $ref: '#/components/schemas/ParamValuePair'
          type: array
      required:
      - inputs
      - outputMethod
      - outputMethodParameters
      - taskCode
      - taskParameters
      - xTransformations
      - yTransformations
      type: object
    UserBlueprintsBulkDelete:
      properties:
        userBlueprintIds:
          description: A list of IDs of user blueprints to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      required:
      - userBlueprintIds
      type: object
    UserBlueprintsBulkDeleteResponse:
      properties:
        failedToDelete:
          description: List of IDs of User Blueprints which failed to be deleted.
          items:
            description: An ID of a User Blueprint which failed to be deleted.
            type: string
          type: array
        successfullyDeleted:
          description: List of IDs of User Blueprints successfully deleted.
          items:
            description: An ID of a User Blueprint successfully deleted.
            type: string
          type: array
      required:
      - failedToDelete
      - successfullyDeleted
      type: object
    UserBlueprintsBulkValidationResponse:
      properties:
        data:
          description: A list of validation responses with their associated User Blueprint
            ID.
          items:
            $ref: '#/components/schemas/UserBlueprintsBulkValidationResponseItem'
          type: array
      required:
      - data
      type: object
    UserBlueprintsBulkValidationResponseItem:
      properties:
        userBlueprintId:
          description: The unique id associated with the user blueprint.
          type: string
        vertexContext:
          description: Info about, warnings about, and errors with a specific vertex
            in the blueprint.
          items:
            $ref: '#/components/schemas/VertexContextItem'
          type: array
      required:
      - userBlueprintId
      - vertexContext
      type: object
    UserBlueprintsDetailedItem:
      properties:
        blender:
          default: false
          description: Whether the blueprint is a blender.
          type: boolean
        blueprint:
          description: The representation of a directed acyclic graph defining a pipeline
            of data through tasks and a final estimator.
          oneOf:
          - description: The representation of a directed acyclic graph defining a
              pipeline of data through tasks and a final estimator.
            items:
              $ref: '#/components/schemas/UserBlueprintsBlueprintTask'
            type: array
          - $ref: '#/components/schemas/AllowExtra'
            description: The compressed and legacy representation of the blueprint.
        blueprintId:
          description: The deterministic id of the blueprint, based on its content.
          type: string
        bpData:
          description: Additional blueprint metadata used to render the blueprint
            in the UI
          oneOf:
          - $ref: '#/components/schemas/BpData'
        customTaskVersionMetadata:
          description: An association of custom entity ids and task ids.
          items:
            items:
              type: string
            maxItems: 2
            minItems: 2
            type: array
          type: array
        decompressedFormat:
          default: false
          description: Whether the blueprint is in the decompressed format.
          type: boolean
        diagram:
          description: The diagram used by the UI to display the blueprint.
          type: string
        features:
          description: A list of the names of tasks used in the blueprint.
          items:
            type: string
          type: array
        featuresText:
          description: A description of the blueprint via the names of tasks used.
          type: string
        hexColumnNameLookup:
          description: A lookup between hex values and data column names used in the
            blueprint.
          items:
            $ref: '#/components/schemas/UserBlueprintsHexColumnNameLookupEntry'
          type: array
        hiddenFromCatalog:
          description: If true, the blueprint will not show up in the catalog
          type: boolean
        icons:
          description: The icon(s) associated with the blueprint.
          items:
            type: integer
          type: array
        insights:
          description: An indication of the insights generated by the blueprint.
          type: string
        isTimeSeries:
          default: false
          description: Whether the blueprint contains time-series tasks.
          type: boolean
        linkedToProjectId:
          description: Whether the user blueprint is linked to a project.
          type: boolean
        modelType:
          description: The generated or provided title of the blueprint.
          type: string
        projectId:
          description: The id of the project the blueprint was originally created
            with, if applicable.
          nullable: true
          type: string
        referenceModel:
          default: false
          description: Whether the blueprint is a reference model.
          type: boolean
        shapSupport:
          default: false
          description: Whether the blueprint supports shapley additive explanations.
          type: boolean
        supportedTargetTypes:
          description: The list of supported targets of the current blueprint.
          items:
            enum:
            - binary
            - multiclass
            - multilabel
            - nonnegative
            - regression
            - unsupervised
            - unsupervisedClustering
            type: string
          type: array
        supportsGpu:
          default: false
          description: Whether the blueprint supports execution on the GPU.
          type: boolean
        supportsNewSeries:
          description: Whether the blueprint supports new series.
          type: boolean
        userBlueprintId:
          description: The unique id associated with the user blueprint.
          type: string
        userId:
          description: The id of the user who owns the blueprint.
          type: string
        vertexContext:
          description: Info about, warnings about, and errors with a specific vertex
            in the blueprint.
          items:
            $ref: '#/components/schemas/VertexContextItem'
          type: array
      required:
      - blender
      - blueprint
      - blueprintId
      - bpData
      - decompressedFormat
      - diagram
      - features
      - featuresText
      - icons
      - insights
      - isTimeSeries
      - modelType
      - referenceModel
      - shapSupport
      - supportedTargetTypes
      - supportsGpu
      - userBlueprintId
      - userId
      - vertexContext
      type: object
    UserBlueprintsHexColumnNameLookupEntry:
      properties:
        colname:
          description: The name of the column.
          type: string
        hex:
          description: A safe hex representation of the column name.
          type: string
        projectId:
          description: The id of the project from which the column name originates.
          type: string
      required:
      - colname
      - hex
      type: object
    UserBlueprintsInputType:
      properties:
        name:
          description: The human-readable name of an input type.
          type: string
        type:
          description: The unique identifier of an input type.
          type: string
      required:
      - name
      - type
      type: object
    UserBlueprintsInputTypesResponse:
      properties:
        inputTypes:
          description: A list of associated pairs of an input types and their human-readable
            names.
          items:
            $ref: '#/components/schemas/UserBlueprintsInputType'
          type: array
      required:
      - inputTypes
      type: object
    UserBlueprintsListItem:
      properties:
        blender:
          default: false
          description: Whether the blueprint is a blender.
          type: boolean
        blueprintId:
          description: The deterministic id of the blueprint, based on its content.
          type: string
        customTaskVersionMetadata:
          description: An association of custom entity ids and task ids.
          items:
            items:
              type: string
            maxItems: 2
            minItems: 2
            type: array
          type: array
        decompressedFormat:
          default: false
          description: Whether the blueprint is in the decompressed format.
          type: boolean
        diagram:
          description: The diagram used by the UI to display the blueprint.
          type: string
        features:
          description: A list of the names of tasks used in the blueprint.
          items:
            type: string
          type: array
        featuresText:
          description: A description of the blueprint via the names of tasks used.
          type: string
        hexColumnNameLookup:
          description: A lookup between hex values and data column names used in the
            blueprint.
          items:
            $ref: '#/components/schemas/UserBlueprintsHexColumnNameLookupEntry'
          type: array
        hiddenFromCatalog:
          description: If true, the blueprint will not show up in the catalog
          type: boolean
        icons:
          description: The icon(s) associated with the blueprint.
          items:
            type: integer
          type: array
        insights:
          description: An indication of the insights generated by the blueprint.
          type: string
        isTimeSeries:
          default: false
          description: Whether the blueprint contains time-series tasks.
          type: boolean
        linkedToProjectId:
          description: Whether the user blueprint is linked to a project.
          type: boolean
        modelType:
          description: The generated or provided title of the blueprint.
          type: string
        projectId:
          description: The id of the project the blueprint was originally created
            with, if applicable.
          nullable: true
          type: string
        referenceModel:
          default: false
          description: Whether the blueprint is a reference model.
          type: boolean
        shapSupport:
          default: false
          description: Whether the blueprint supports shapley additive explanations.
          type: boolean
        supportedTargetTypes:
          description: The list of supported targets of the current blueprint.
          items:
            enum:
            - binary
            - multiclass
            - multilabel
            - nonnegative
            - regression
            - unsupervised
            - unsupervisedClustering
            type: string
          type: array
        supportsGpu:
          default: false
          description: Whether the blueprint supports execution on the GPU.
          type: boolean
        supportsNewSeries:
          description: Whether the blueprint supports new series.
          type: boolean
        userBlueprintId:
          description: The unique id associated with the user blueprint.
          type: string
        userId:
          description: The id of the user who owns the blueprint.
          type: string
      required:
      - blender
      - blueprintId
      - decompressedFormat
      - diagram
      - features
      - featuresText
      - icons
      - insights
      - isTimeSeries
      - modelType
      - referenceModel
      - shapSupport
      - supportedTargetTypes
      - supportsGpu
      - userBlueprintId
      - userId
      type: object
    UserBlueprintsListResponse:
      properties:
        count:
          description: Number of records on this page
          type: integer
        data:
          description: List of user blueprints
          items:
            $ref: '#/components/schemas/UserBlueprintsListItem'
          maxItems: 100
          type: array
        next:
          description: URL to the next page, or `null` if there is no such page
          nullable: true
          type: string
        previous:
          description: URL to the previous page, or `null` if there is no such page
          nullable: true
          type: string
        totalCount:
          description: Total number of records
          type: integer
      required:
      - count
      - data
      - next
      - previous
      type: object
    UserBlueprintsRetrieveResponse:
      properties:
        blender:
          default: false
          description: Whether the blueprint is a blender.
          type: boolean
        blueprint:
          description: The representation of a directed acyclic graph defining a pipeline
            of data through tasks and a final estimator.
          oneOf:
          - description: The representation of a directed acyclic graph defining a
              pipeline of data through tasks and a final estimator.
            items:
              $ref: '#/components/schemas/UserBlueprintsBlueprintTask'
            type: array
          - $ref: '#/components/schemas/AllowExtra'
            description: The compressed and legacy representation of the blueprint.
        blueprintId:
          description: The deterministic id of the blueprint, based on its content.
          type: string
        bpData:
          description: Additional blueprint metadata used to render the blueprint
            in the UI
          oneOf:
          - $ref: '#/components/schemas/BpData'
        customTaskVersionMetadata:
          description: An association of custom entity ids and task ids.
          items:
            items:
              type: string
            maxItems: 2
            minItems: 2
            type: array
          type: array
        decompressedFormat:
          default: false
          description: Whether the blueprint is in the decompressed format.
          type: boolean
        diagram:
          description: The diagram used by the UI to display the blueprint.
          type: string
        features:
          description: A list of the names of tasks used in the blueprint.
          items:
            type: string
          type: array
        featuresText:
          description: A description of the blueprint via the names of tasks used.
          type: string
        hexColumnNameLookup:
          description: A lookup between hex values and data column names used in the
            blueprint.
          items:
            $ref: '#/components/schemas/UserBlueprintsHexColumnNameLookupEntry'
          type: array
        hiddenFromCatalog:
          description: If true, the blueprint will not show up in the catalog
          type: boolean
        icons:
          description: The icon(s) associated with the blueprint.
          items:
            type: integer
          type: array
        insights:
          description: An indication of the insights generated by the blueprint.
          type: string
        isTimeSeries:
          default: false
          description: Whether the blueprint contains time-series tasks.
          type: boolean
        linkedToProjectId:
          description: Whether the user blueprint is linked to a project.
          type: boolean
        modelType:
          description: The generated or provided title of the blueprint.
          type: string
        projectId:
          description: The id of the project the blueprint was originally created
            with, if applicable.
          nullable: true
          type: string
        referenceModel:
          default: false
          description: Whether the blueprint is a reference model.
          type: boolean
        shapSupport:
          default: false
          description: Whether the blueprint supports shapley additive explanations.
          type: boolean
        supportedTargetTypes:
          description: The list of supported targets of the current blueprint.
          items:
            enum:
            - binary
            - multiclass
            - multilabel
            - nonnegative
            - regression
            - unsupervised
            - unsupervisedClustering
            type: string
          type: array
        supportsGpu:
          default: false
          description: Whether the blueprint supports execution on the GPU.
          type: boolean
        supportsNewSeries:
          description: Whether the blueprint supports new series.
          type: boolean
        userBlueprintId:
          description: The unique id associated with the user blueprint.
          type: string
        userId:
          description: The id of the user who owns the blueprint.
          type: string
        vertexContext:
          description: Info about, warnings about, and errors with a specific vertex
            in the blueprint.
          items:
            $ref: '#/components/schemas/VertexContextItem'
          type: array
      required:
      - blender
      - blueprintId
      - decompressedFormat
      - diagram
      - features
      - featuresText
      - icons
      - insights
      - isTimeSeries
      - modelType
      - referenceModel
      - shapSupport
      - supportedTargetTypes
      - supportsGpu
      - userBlueprintId
      - userId
      type: object
    UserBlueprintsValidateTaskParameter:
      properties:
        message:
          description: The description of the issue with the proposed task parameter
            value.
          type: string
        paramName:
          description: The name of the validated task parameter.
          type: string
        value:
          description: The invalid value proposed for the validated task parameter.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            nullable: true
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              nullable: true
            type: array
      required:
      - message
      - paramName
      - value
      type: object
    UserBlueprintsValidateTaskParametersResponse:
      properties:
        errors:
          description: A list of the task parameters, their proposed values, and messages
            describing why each is not valid.
          items:
            $ref: '#/components/schemas/UserBlueprintsValidateTaskParameter'
          type: array
      required:
      - errors
      type: object
    UserBlueprintsValidationResponse:
      properties:
        vertexContext:
          description: Info about, warnings about, and errors with a specific vertex
            in the blueprint.
          items:
            $ref: '#/components/schemas/VertexContextItem'
          type: array
      required:
      - vertexContext
      type: object
    UserBulkCreate:
      properties:
        add:
          description: List of User objects to create with associated RequestIds
          items:
            $ref: '#/components/schemas/UserBulkCreateObject'
          maxItems: 50
          minItems: 1
          type: array
      required:
      - add
      type: object
    UserBulkCreateObject:
      properties:
        attributionId:
          description: User ID in external marketing systems (SFDC)
          type: string
        company:
          description: Company where the user works.
          type: string
        country:
          description: Country where the user lives.
          format: ISO 3166-1 alpha-2 code
          type: string
        defaultCatalogDatasetSampleSize:
          $ref: '#/components/schemas/AdminSampleSize'
          description: Size of a sample to propose by default when enabling Fast Registration
            workflow.
          x-versionadded: v2.27
        expirationDate:
          description: Datetime, RFC3339, at which the user should expire.
          format: date-time
          type: string
        externalId:
          description: User ID in external IdP.
          type: string
        firstName:
          description: First name of the user being created.
          type: string
        jobTitle:
          description: Job Title the user has.
          type: string
        language:
          default: en
          description: 'Sets the language in the app for the user, and the language
            of the invite email, if the user is being invited (i.e. the password is
            omitted). Value must be a valid ISO-639-1 language code. Available options
            are: `en`, `ja`, `fr`, `ko`. System''s default language will be used if
            omitted.'
          enum:
          - ar_001
          - de_DE
          - en
          - es_419
          - fr
          - ja
          - ko
          - pt_BR
          - test
          - uk_UA
          type: string
        lastName:
          description: Last name of the user being created.
          type: string
        maxGpuWorkers:
          description: Amount of user's available GPU workers.
          type: integer
        maxIdleWorkers:
          description: Amount of org workers that the user can utilize when idle.
          type: integer
        maxUploadSize:
          description: The upper limit for the allowed upload size for this user.
          type: integer
        maxUploadSizeCatalog:
          description: The upper limit for the allowed upload size in the AI catalog
            for this user.
          type: integer
        maxWorkers:
          description: Amount of user's available workers.
          type: integer
        organizationId:
          description: ID of the organization to add the user to.
          type: string
        password:
          description: Creates user with this password, if blank sends username invite.
          type: string
        requestId:
          description: Caller-provided unique identifier for matching user create
            request to result in response
          type: string
        requireClickthroughAgreement:
          description: Boolean to require the user to agree to a clickthrough.
          type: boolean
        userType:
          description: External name for UserType such as AcademicUser, BasicUser,
            ProUser.
          enum:
          - AcademicUser
          - BasicUser
          - ProUser
          - PayAsYouGoUser
          - TrialUser
          - Covid19TrialUser
          type: string
        username:
          description: Email address of new user.
          type: string
      required:
      - firstName
      - requestId
      - userType
      - username
      type: object
    UserBulkCreateResponse:
      properties:
        count:
          description: Number of results within the data field.
          minimum: 0
          type: integer
        data:
          description: List of User object results, corresponding to the creation
            request.
          items:
            $ref: '#/components/schemas/UserBulkCreateResponseObject'
          type: array
      required:
      - count
      - data
      type: object
    UserBulkCreateResponseData:
      properties:
        message:
          description: Error or other response message from the creation request if
            present.
          type: string
        notifyStatus:
          $ref: '#/components/schemas/NotifyStatus'
          description: User notification values if created and applicable.
        userId:
          description: The ID of the user if created.
          type: string
        username:
          description: The username of the user if created.
          type: string
      type: object
    UserBulkCreateResponseObject:
      properties:
        data:
          $ref: '#/components/schemas/UserBulkCreateResponseData'
          description: Response message/data from this specific User creation request
        requestId:
          description: Caller-provided unique identifier for matching user create
            request to result in response
          type: string
        statusCode:
          description: HTTP status code for this user creation request
          minimum: 100
          type: integer
      required:
      - data
      - requestId
      - statusCode
      type: object
    UserCreate:
      properties:
        attributionId:
          description: User ID in external marketing systems (SFDC)
          type: string
        company:
          description: Company where the user works.
          type: string
        country:
          description: Country where the user lives.
          format: ISO 3166-1 alpha-2 code
          type: string
        defaultCatalogDatasetSampleSize:
          $ref: '#/components/schemas/AdminSampleSize'
          description: Size of a sample to propose by default when enabling Fast Registration
            workflow.
          x-versionadded: v2.27
        expirationDate:
          description: Datetime, RFC3339, at which the user should expire.
          format: date-time
          type: string
        externalId:
          description: User ID in external IdP.
          type: string
        firstName:
          description: First name of the user being created.
          type: string
        jobTitle:
          description: Job Title the user has.
          type: string
        language:
          default: en
          description: 'Sets the language in the app for the user, and the language
            of the invite email, if the user is being invited (i.e. the password is
            omitted). Value must be a valid ISO-639-1 language code. Available options
            are: `en`, `ja`, `fr`, `ko`. System''s default language will be used if
            omitted.'
          enum:
          - ar_001
          - de_DE
          - en
          - es_419
          - fr
          - ja
          - ko
          - pt_BR
          - test
          - uk_UA
          type: string
        lastName:
          description: Last name of the user being created.
          type: string
        maxGpuWorkers:
          description: Amount of user's available GPU workers.
          type: integer
        maxIdleWorkers:
          description: Amount of org workers that the user can utilize when idle.
          type: integer
        maxUploadSize:
          description: The upper limit for the allowed upload size for this user.
          type: integer
        maxUploadSizeCatalog:
          description: The upper limit for the allowed upload size in the AI catalog
            for this user.
          type: integer
        maxWorkers:
          description: Amount of user's available workers.
          type: integer
        organizationId:
          description: ID of the organization to add the user to.
          type: string
        password:
          description: Creates user with this password, if blank sends username invite.
          type: string
        requireClickthroughAgreement:
          description: Boolean to require the user to agree to a clickthrough.
          type: boolean
        userType:
          description: External name for UserType such as AcademicUser, BasicUser,
            ProUser.
          enum:
          - AcademicUser
          - BasicUser
          - ProUser
          - PayAsYouGoUser
          - TrialUser
          - Covid19TrialUser
          type: string
        username:
          description: Email address of new user.
          type: string
      required:
      - firstName
      - userType
      - username
      type: object
    UserCreateResponse:
      properties:
        notifyStatus:
          $ref: '#/components/schemas/NotifyStatus'
          description: User notification values.
        userId:
          description: The ID of the user.
          type: string
        username:
          description: The username of the user.
          type: string
      required:
      - userId
      - username
      type: object
    UserGroupBulkDelete:
      properties:
        groups:
          description: The groups to remove.
          items:
            $ref: '#/components/schemas/UserGroupRetrieve'
          maxItems: 100
          type: array
      required:
      - groups
      type: object
    UserGroupCreate:
      properties:
        accessRoleId:
          description: The identifier of the access role assigned to the group.
          type: string
        description:
          description: The description of this user group.
          maxLength: 1000
          type: string
        email:
          description: The email that can be used to contact this user group.
          type: string
        name:
          description: The name of the new user group. Must be unique.
          maxLength: 100
          type: string
        orgId:
          description: The organization identifier of this user group.
          type: string
      required:
      - name
      - orgId
      type: object
    UserGroupResponse:
      properties:
        accessRoleId:
          description: The identifier of the access role assigned to the group.
          nullable: true
          type: string
        accessRoleName:
          description: The name of the access role assigned to the group.
          nullable: true
          type: string
        accountPermissions:
          additionalProperties:
            type: boolean
          description: Account permissions of this user group. Each key is a permission
            name.
          type: object
        createdBy:
          description: The identifier of the user who created this user group.
          nullable: true
          type: string
        description:
          description: The description of this user group.
          nullable: true
          type: string
        email:
          description: The email of this user group.
          nullable: true
          type: string
        id:
          description: The identifier of the user group.
          type: string
        maxCustomDeployments:
          description: The number of maximum custom deployments available for users
            of this group.
          nullable: true
          type: integer
        maxCustomDeploymentsLimit:
          description: The upper limit for the number of maximum custom deployments.
            The limit is defined if the group is part of an organization, and the
            attribute is set on the organization level.
          nullable: true
          type: integer
        maxEdaWorkers:
          description: The upper limit for a number of EDA workers to be run for users
            of this user group.
          nullable: true
          type: integer
        maxRam:
          description: The upper limit for amount of RAM available to users of this
            user group.
          nullable: true
          type: integer
        maxUploadCatalogSizeLimit:
          description: The upper limit for the maximum upload size in the AI catalog.
            The limit is defined if the group is part of an organization, and the
            attribute is set on the organization level.
          nullable: true
          type: integer
        maxUploadSize:
          description: The maximum allowed upload size for users of this group.
          nullable: true
          type: integer
        maxUploadSizeCatalog:
          description: The maximum allowed upload size in the AI catalog for users
            in this group.
          nullable: true
          type: integer
        maxUploadSizeLimit:
          description: The upper limit for the maximum allowed upload size. The limit
            is defined if the group is part of an organization, and the attribute
            is set on the organization level.
          nullable: true
          type: integer
        maxWorkers:
          description: The upper limit for a number of workers to be run for users
            of this user group.
          nullable: true
          type: integer
        membersCount:
          description: The number of members in this user group.
          type: integer
        name:
          description: The name of the user group.
          type: string
        orgId:
          description: The identifier of the organization the user group belongs to.
          nullable: true
          type: string
        orgName:
          description: The name of the organization this user group belongs to.
          nullable: true
          type: string
      required:
      - accessRoleId
      - accessRoleName
      - accountPermissions
      - createdBy
      - description
      - email
      - id
      - maxCustomDeployments
      - maxCustomDeploymentsLimit
      - maxEdaWorkers
      - maxRam
      - maxUploadCatalogSizeLimit
      - maxUploadSize
      - maxUploadSizeCatalog
      - maxUploadSizeLimit
      - maxWorkers
      - membersCount
      - name
      - orgId
      - orgName
      type: object
    UserGroupRetrieve:
      properties:
        groupId:
          description: The identifier of the user group.
          type: string
      required:
      - groupId
      type: object
    UserGroupUpdate:
      properties:
        accessRoleId:
          description: The identifier of the access role to assign to the group.
          nullable: true
          type: string
        accountPermissions:
          additionalProperties:
            type: boolean
          description: Account permissions to set for this user group. Each key is
            a permission name.
          type: object
        description:
          description: The description of this user group.
          maxLength: 1000
          type: string
        email:
          description: The email of this user group.
          type: string
        name:
          description: The new name for the user group.
          maxLength: 100
          type: string
        orgId:
          description: The id of the organization to assign the user group to.
          type: string
      type: object
    UserGroupsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of user groups that match the query condition.
          items:
            $ref: '#/components/schemas/UserGroupResponse'
          type: array
        next:
          description: The URL to the next page.
          format: uri
          nullable: true
          type: string
        previous:
          description: The URL to the previous page.
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items that match the query condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    UserInGroup:
      properties:
        expirationDate:
          description: The expiration date of the user account, if applicable
          nullable: true
          type: string
        firstName:
          description: The first name of the user.
          nullable: true
          type: string
        lastName:
          description: The last name of the user.
          nullable: true
          type: string
        organization:
          description: The name of the organization the user is part of.
          nullable: true
          type: string
        scheduledForDeletion:
          description: If the user is scheduled for deletion. Will be returned when
            an appropriate FF is enabled.
          type: boolean
        status:
          description: The status of the user, `active` if the has been activated,
            `inactive` otherwise.
          enum:
          - active
          - inactive
          nullable: true
          type: string
        userId:
          description: The identifier of the user.
          nullable: true
          type: string
        username:
          description: The name of the user.
          type: string
      required:
      - firstName
      - lastName
      - organization
      - status
      - userId
      - username
      type: object
    UserInfo:
      properties:
        firstName:
          description: First Name.
          type: string
        lastName:
          description: Last Name.
          type: string
        userId:
          description: ID of the User.
          type: string
        username:
          description: Username.
          type: string
      required:
      - firstName
      - lastName
      - userId
      - username
      type: object
    UserMetadata:
      properties:
        email:
          description: Email of the user
          nullable: true
          type: string
        id:
          description: ID of the user
          type: string
        name:
          description: Full name of the user
          nullable: true
          type: string
      required:
      - email
      - id
      - name
      type: object
    UserNotificationListResponse:
      properties:
        count:
          description: Number of items returned on this page.
          type: integer
        data:
          description: An array of user's notifications.
          items:
            $ref: '#/components/schemas/UserNotificationResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UserNotificationRelatedCommentResponse:
      properties:
        commentId:
          description: The ID of the comment
          type: string
        commentLink:
          description: The link to the comment.
          type: string
        entityId:
          description: The ID of the commented entity
          type: string
        entityType:
          description: The type of the commented entity.
          enum:
          - useCase
          - model
          - catalog
          type: string
        inactive:
          description: True if the comment was deleted.
          type: boolean
      required:
      - commentId
      - entityId
      type: object
    UserNotificationRelatedDeploymentResponse:
      properties:
        deploymentId:
          description: The ID of the deployment
          type: string
        deploymentName:
          description: Deployment's label
          nullable: true
          type: string
        deploymentUrl:
          description: The link to the deployment
          type: string
        inactive:
          description: True if the deployment was deleted.
          type: boolean
        modelId:
          description: The ID of the related model
          nullable: true
          type: string
        projectId:
          description: The ID of the related project
          nullable: true
          type: string
        userId:
          description: The ID of the related user
          nullable: true
          type: string
      required:
      - deploymentId
      type: object
    UserNotificationRelatedProjectResponse:
      properties:
        inactive:
          description: True if the project was deleted.
          type: boolean
        pid:
          description: The ID of the project
          type: string
        projectLink:
          description: The link to the project.
          type: string
        projectName:
          description: Project name.
          nullable: true
          type: string
      required:
      - pid
      type: object
    UserNotificationRelatedSecureConfigResponse:
      properties:
        secureConfigLink:
          description: Link to the secure config.
          type: string
        secureConfigName:
          description: Name of the secure config.
          type: string
        secureConfigSchemaName:
          description: Type uuid of the secure config.
          type: string
        secureConfigSchemaUuid:
          description: Type name of the secure config.
          type: string
        secureConfigUuid:
          description: ID of the secure config.
          type: string
      required:
      - secureConfigLink
      - secureConfigName
      - secureConfigSchemaName
      - secureConfigSchemaUuid
      - secureConfigUuid
      type: object
    UserNotificationRelatedUserResponse:
      properties:
        fullName:
          description: User's full name.
          nullable: true
          type: string
        gravatarHash:
          description: User's gravatar hash.
          type: string
        inactive:
          description: True if the user was deleted.
          type: boolean
        uid:
          description: The ID of the user
          type: string
        username:
          description: Username of the user.
          type: string
      required:
      - uid
      type: object
    UserNotificationRelatedUsersDeleteResponse:
      properties:
        reportId:
          description: The ID of the users permanent delete report
          type: string
        statusId:
          description: The ID of the users delete status.
          type: string
        usersToDeleteCount:
          description: Number of users that will be deleted.
          type: string
      required:
      - reportId
      - statusId
      - usersToDeleteCount
      type: object
    UserNotificationResponse:
      properties:
        callerUser:
          $ref: '#/components/schemas/UserNotificationRelatedUserResponse'
          description: Details about the user who triggered the notification.
          nullable: true
        created:
          description: The ISO 8601 formatted date and time when the notification
            was created.
          format: date-time
          type: string
        description:
          description: Notification's description
          nullable: true
          type: string
        eventType:
          description: The type of the notification.
          enum:
          - autopilot.complete
          - project.shared
          - comment.created
          - comment.updated
          - model_deployments.service_health_red
          - model_deployments.data_drift_red
          - model_deployments.accuracy_red
          - model_deployments.health.fairness_health.red
          - model_deployments.health.custom_metrics_health.red
          - model_deployments.predictions_timeliness_health_red
          - model_deployments.actuals_timeliness_health_red
          - model_deployments.challenger_scoring_finished
          - credits_system.credits_applied
          - credits_system.credits_expired
          - credits_system.empty_balance
          - credits_system.credits_usage
          - misc.asset_access_request
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - perma_delete_project.failure
          - perma_delete_project.success
          - decision_flow.shared
          - secure_config.shared
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          type: string
        isRead:
          description: True if the notification is already read.
          type: boolean
        link:
          description: Call-to-action link for the notification
          type: string
        pushNotificationSent:
          description: True if the notification was also sent via push notifications.
          type: boolean
        relatedComment:
          $ref: '#/components/schemas/UserNotificationRelatedCommentResponse'
          description: Details about the comment related to the notification.
        relatedDeployment:
          $ref: '#/components/schemas/UserNotificationRelatedDeploymentResponse'
          description: Details about the deployment related to the notification.
        relatedProject:
          $ref: '#/components/schemas/UserNotificationRelatedProjectResponse'
          description: Details about the project related to the notification.
        relatedSecureConfig:
          $ref: '#/components/schemas/UserNotificationRelatedSecureConfigResponse'
          description: Details about the secure config related to the notification.
        relatedUsersDelete:
          $ref: '#/components/schemas/UserNotificationRelatedUsersDeleteResponse'
          description: Details about the users permanent delete.
        sharedUsers:
          description: List of the user details a resource was shared with.
          items:
            $ref: '#/components/schemas/UserNotificationRelatedUserResponse'
          type: array
        statusId:
          description: Asynchronous job status ID
          type: string
        title:
          description: Notification's title
          nullable: true
          type: string
        tooltip:
          description: Notification's tooltip
          nullable: true
          type: string
        updated:
          description: The ISO 8601 formatted date and time when the notification
            was updated.
          format: date-time
          type: string
        userNotificationId:
          description: The ID of the notification
          type: string
      required:
      - callerUser
      - created
      - description
      - eventType
      - isRead
      - link
      - pushNotificationSent
      - title
      - tooltip
      - updated
      - userNotificationId
      type: object
    UserOperations:
      properties:
        canCancel:
          description: Whether the user can cancel the Change Request.
          type: boolean
        canComment:
          description: Whether the user can create commenting review on the Change
            Request.
          type: boolean
        canResolve:
          description: Whether the user can resolve the Change Request.
          type: boolean
        canReview:
          description: Whether the user can review (approve or request updates) the
            Change Request.
          type: boolean
        canUpdate:
          description: Whether the user can update the Change Request.
          type: boolean
      required:
      - canCancel
      - canComment
      - canResolve
      - canReview
      - canUpdate
      type: object
    UserRoleWithGrant:
      properties:
        canShare:
          default: true
          description: Whether the org/group/user should be able to share with others.If
            true, the org/group/user will be able to grant any role up to and includingtheir
            own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored.
          type: boolean
        role:
          description: The role to set on the entity. When it is None, the role of
            this user will be removedfrom this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          nullable: true
          type: string
        username:
          description: Username of the user to update the access role for.
          type: string
      required:
      - role
      - username
      type: object
    Username:
      properties:
        username:
          description: The name of the user.
          type: string
      required:
      - username
      type: object
    UsersPermadelete:
      properties:
        orgId:
          default: null
          description: Organization which's users to be permanently deleted.
          nullable: true
          type: string
        orphansOwner:
          default: null
          description: User which becomes an owner of any projects or deployments
            that otherwise cause an error because they would be orphaned.
          nullable: true
          type: string
        userIds:
          description: Users to be permanently deleted.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
      type: object
    UsersPermadeleteDeleteReportParamsResponse:
      properties:
        data:
          $ref: '#/components/schemas/UsersPermadeleteResponse'
          description: The users cleanup delete parameters.
        message:
          description: May contain further details.
          nullable: true
          type: string
      required:
      - data
      - message
      type: object
    UsersPermadeleteJobResponse:
      properties:
        message:
          description: Information about the users perma-deletion job submission.
          nullable: true
          type: string
      required:
      - message
      type: object
    UsersPermadeleteJobStatusResponse:
      properties:
        created:
          description: The time the status record was created.
          format: date-time
          type: string
        data:
          $ref: '#/components/schemas/SummaryPermadeleteStatus'
          description: Report id and associated status.
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        status:
          description: The processing state of the job.
          enum:
          - ABORTED
          - COMPLETED
          - ERROR
          - EXPIRED
          - INITIALIZED
          - RUNNING
          type: string
        statusId:
          description: The ID of the status object.
          type: string
      required:
      - created
      - data
      - message
      - status
      - statusId
      type: object
    UsersPermadeletePreviewJobResponse:
      properties:
        message:
          description: Information about the users perma-deletion preview job submission.
          nullable: true
          type: string
      required:
      - message
      type: object
    UsersPermadeletePreviewJobStatusResponse:
      properties:
        created:
          description: The time the status record was created.
          format: date-time
          type: string
        data:
          $ref: '#/components/schemas/PreviewPermadeleteStatus'
          description: Preview report id and associated status.
        message:
          description: May contain further information about the status.
          nullable: true
          type: string
        status:
          description: The processing state of the job.
          enum:
          - ABORTED
          - COMPLETED
          - ERROR
          - EXPIRED
          - INITIALIZED
          - RUNNING
          type: string
        statusId:
          description: The ID of the status object.
          type: string
      required:
      - created
      - data
      - message
      - status
      - statusId
      type: object
    UsersPermadeletePreviewStatistics:
      properties:
        deploymentsWillBeAssignedNewOwner:
          description: Number of deployments that will be assigned a new owner.
          type: integer
        deploymentsWillBeDeleted:
          description: Number of deployments that will be deleted.
          type: integer
        deploymentsWillNotBeDeleted:
          description: Number of deployments that will not be deleted.
          type: integer
        errors:
          description: Number of errors encountered during preview construction.
          type: integer
        projectsWillBeAssignedNewOwner:
          description: Number of projects that will be assigned a new owner.
          type: integer
        projectsWillBeDeleted:
          description: Number of projects that will be deleted.
          type: integer
        projectsWillNotBeDeleted:
          description: Number of projects that will not be deleted.
          type: integer
        usersWillBeDeleted:
          description: Number of users that will be deleted.
          type: integer
        usersWillNotBeDeleted:
          description: Number of users that will not be deleted.
          type: integer
      required:
      - deploymentsWillBeAssignedNewOwner
      - deploymentsWillBeDeleted
      - deploymentsWillNotBeDeleted
      - errors
      - projectsWillBeAssignedNewOwner
      - projectsWillBeDeleted
      - projectsWillNotBeDeleted
      - usersWillBeDeleted
      - usersWillNotBeDeleted
      type: object
    UsersPermadeletePreviewStatisticsResponse:
      properties:
        data:
          $ref: '#/components/schemas/UsersPermadeletePreviewStatistics'
          description: The users cleanup report statistics.
        message:
          description: May contain further details.
          nullable: true
          type: string
      required:
      - data
      - message
      type: object
    UsersPermadeleteResponse:
      properties:
        orgId:
          default: null
          description: Organization which's users to be permanently deleted.
          nullable: true
          type: string
        orphansOwner:
          default: null
          description: User which becomes an owner of any projects or deployments
            that otherwise cause an error because they would be orphaned.
          nullable: true
          type: string
        orphansOwnerName:
          description: User which becomes an owner of any projects or deployments
            that otherwise cause an error because they would be orphaned.
          type: string
        userIds:
          description: Users to be permanently deleted.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
      type: object
    UsersPermadeleteSummaryReportStatistics:
      properties:
        deploymentsAssignedNewOwner:
          description: Number of deployments that are assigned a new owner.
          type: integer
        deploymentsDeleted:
          description: Number of deployments that are deleted.
          type: integer
        deploymentsNotDeleted:
          description: Number of deployments that are not deleted.
          type: integer
        errors:
          description: Number of errors encountered during users deletion.
          type: integer
        projectsAssignedNewOwner:
          description: Number of projects that are assigned a new owner.
          type: integer
        projectsDeleted:
          description: Number of projects that are deleted.
          type: integer
        projectsNotDeleted:
          description: Number of projects that are not deleted.
          type: integer
        usersDeleted:
          description: Number of users that are deleted.
          type: integer
        usersNotDeleted:
          description: Number of users that are not deleted.
          type: integer
      required:
      - deploymentsAssignedNewOwner
      - deploymentsDeleted
      - deploymentsNotDeleted
      - errors
      - projectsAssignedNewOwner
      - projectsDeleted
      - projectsNotDeleted
      - usersDeleted
      - usersNotDeleted
      type: object
    UsersPermadeleteSummaryReportStatisticsResponse:
      properties:
        data:
          $ref: '#/components/schemas/UsersPermadeleteSummaryReportStatistics'
          description: The users cleanup summary report statistics.
        message:
          description: May contain further details.
          nullable: true
          type: string
      required:
      - data
      - message
      type: object
    ValidationCheck:
      properties:
        message:
          description: Message of the validation check.
          type: string
        status:
          description: Status of the validation check.
          enum:
          - failing
          - passing
          - warning
          type: string
      required:
      - message
      - status
      type: object
    ValidationChecks:
      properties:
        combinedModelSegments:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has same segments as the current
            model in case any of them is segmented model.
        containsTrackedSegmentAttributes:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the currently tracked segment attributes are contained
            within the replacement model's universe dataset.
        driftTracking:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has the necessary info to enable
            data drift.
          x-versionadded: v2.29
        featureDataTypes:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the common features of replacement model and current
            model have the same data types; a warning will be issued if a mismatch
            is found.
        features:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model and the current model have the
            same set of features; a warning will be issued if the replacement model
            has additional features.
        humilityRules:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model is compatible with existing humility
            rules set up on the deployment
        modelCanBeDeployed:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model can be deployed.
        modelStatus:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has finished building.
        notCurrentModel:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model is the same as the current model.
        permission:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether a user has permission to replace the model.
        predictionIntervals:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model supports prediction intervals.
        predictionReady:
          $ref: '#/components/schemas/ValidationCheck'
          description: If deployment is an External deployment and the replacement
            model is a DataRobot or Custom Model, the deployment will not be able
            to make predictions. The replacement model package must first be replaced
            on the external prediction environment.
        seriesType:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has the same series type name
            as the current model. For example, multiseries models cannot replace non-multiseries
            models.
        supported:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether model replacement is supported by the deployment.
        target:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has the same target name as the
            current model.
        targetClasses:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has the same target class mapping
            as the current model.
        targetType:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the replacement model has the same target type as the
            current model.For example, a binary classification model cannot replace
            a regression model.
        timeSeriesCompatibility:
          $ref: '#/components/schemas/ValidationCheck'
          description: Time series models cannot replace non-time-series models, and
            vice versa.
        validChallenger:
          $ref: '#/components/schemas/ValidationCheck'
          description: Whether the model being replaced can be added as a model challenger
            if the deployment has challengers enabled.
      type: object
    ValueField:
      properties:
        columnName:
          description: Column name
          nullable: true
          type: string
      required:
      - columnName
      type: object
    ValueTracker:
      properties:
        businessImpact:
          description: Expected effects on overall business operations
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        commentId:
          description: The id for this comment
          type: string
        content:
          description: A string
          type: string
        description:
          description: class ValueTracker description
          maxLength: 1024
          type: string
        feasibility:
          description: Assessment of how the class ValueTracker can be accomplished
            across multiple dimensions
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        id:
          description: The id of this description item
          nullable: true
          type: string
        mentions:
          description: A list of user objects
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        name:
          description: Name of the class ValueTracker
          maxLength: 512
          type: string
        notes:
          description: User notes
          nullable: true
          type: string
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
          description: User case owner
          nullable: true
        permissions:
          description: Permissions of current user
          items:
            type: string
          nullable: true
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          description: Optional, Contains Template type and parameter information
          nullable: true
        predictionTargets:
          description: An array of strings prediction target names
          items:
            description: The name of the prediction target
            type: string
          type: array
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        stage:
          description: Current stage of class ValueTracker
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: Array of TargetDate objects
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          type: array
      required:
      - name
      type: object
    ValueTrackerActivity:
      properties:
        eventDescription:
          $ref: '#/components/schemas/ValueTrackerEventDescriptions'
          description: Details of the activity, content depends on activity type
          nullable: true
        eventType:
          description: The type of activity
          nullable: true
          type: string
        firstName:
          description: First name of class ValueTracker owner
          nullable: true
          type: string
        id:
          description: The id of the class ValueTracker activity
          type: string
        lastName:
          description: Last of class ValueTracker owner
          nullable: true
          type: string
        timestamp:
          description: The timestamp of the activity
          format: date-time
          type: string
        user:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
          description: Information about the user the initiated the event
        username:
          description: Username of class ValueTracker owner
          type: string
      required:
      - eventDescription
      - eventType
      - timestamp
      - user
      type: object
    ValueTrackerActivityListResponse:
      properties:
        count:
          description: The number of items returned on this page
          type: integer
        data:
          description: The activities of a class ValueTracker
          items:
            $ref: '#/components/schemas/ValueTrackerActivity'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The number of items matching the query condition
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ValueTrackerAttachment:
      properties:
        attachedObjectId:
          description: The id of the attached object
          type: string
        type:
          description: class ValueTracker attachment type
          enum:
          - dataset
          - modelingProject
          - deployment
          - customModel
          - modelPackage
          - application
          type: string
      required:
      - attachedObjectId
      - type
      type: object
    ValueTrackerAttachmentApplicationOverview:
      properties:
        appType:
          description: Type of the application
          type: string
        createdAt:
          description: Time when application was created
          format: date-time
          type: string
        lastModifiedAt:
          description: Time of the last modification
          format: date-time
          type: string
        name:
          description: Name of the application
          type: string
        version:
          description: Version string of the app
          type: string
      required:
      - appType
      - createdAt
      - lastModifiedAt
      - name
      - version
      type: object
    ValueTrackerAttachmentCustomModelOverview:
      properties:
        createdAt:
          description: Time when custom model was created
          format: date-time
          type: string
        modifiedAt:
          description: Time of the last modification
          format: date-time
          type: string
        name:
          description: Name of the custom model
          type: string
        owner:
          description: Name of the custom model owner
          type: string
      required:
      - createdAt
      - modifiedAt
      - name
      - owner
      type: object
    ValueTrackerAttachmentDatasetOverview:
      properties:
        createdAt:
          description: Time when dataset was created
          format: date-time
          type: string
        createdBy:
          description: Name of user who created the dataset
          type: string
        lastModifiedAt:
          description: Time of the last modification
          format: date-time
          type: string
        lastModifiedBy:
          description: Name of user who did last modification
          type: string
        name:
          description: Name of the dataset
          type: string
      required:
      - createdAt
      - createdBy
      - lastModifiedAt
      - lastModifiedBy
      - name
      type: object
    ValueTrackerAttachmentDeploymentHealth:
      properties:
        endDate:
          description: End date of health status
          format: date-time
          type: string
        message:
          description: Health status related information
          type: string
        startDate:
          description: Start date of health status
          format: date-time
          type: string
        status:
          description: Health status
          type: string
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    ValueTrackerAttachmentDeploymentOverview:
      properties:
        accuracyHealth:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentHealth'
          description: Accuracy related health status
        modelHealth:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentHealth'
          description: Model related health status
        name:
          description: Name of the deployment
          type: string
        predictionServer:
          description: Name of prediction server
          type: string
        predictionUsage:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentPredictionUsage'
          description: class ValueTracker attachment detail for Deployment usage
        serviceHealth:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentHealth'
          description: Service related health status
      required:
      - accuracyHealth
      - modelHealth
      - name
      - predictionServer
      - predictionUsage
      - serviceHealth
      type: object
    ValueTrackerAttachmentDeploymentPredictionUsage:
      properties:
        dailyRates:
          description: List of daily request counts
          items:
            type: integer
          type: array
        lastTimestamp:
          description: Last prediction time
          format: date-time
          type: string
      required:
      - dailyRates
      - lastTimestamp
      type: object
    ValueTrackerAttachmentListResponse:
      properties:
        count:
          description: Number of results returned
          type: integer
        data:
          description: An array of attachment objects
          items:
            $ref: '#/components/schemas/ValueTrackerAttachmentResponse'
          type: array
        next:
          description: Link to next page
          nullable: true
          type: string
        previous:
          description: Link to previous page
          nullable: true
          type: string
        totalCount:
          description: Total number of results available
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ValueTrackerAttachmentModelPackageOverview:
      properties:
        createdAt:
          description: Time when model package was created
          format: date-time
          type: string
        deploymentCount:
          description: Number of deployments
          type: integer
        executionType:
          description: Type of execution
          type: string
        name:
          description: Name of the model package
          type: string
        targetName:
          description: Name of modeling target
          type: string
        targetType:
          description: Type of modeling target
          type: string
      required:
      - createdAt
      - deploymentCount
      - executionType
      - name
      - targetName
      - targetType
      type: object
    ValueTrackerAttachmentModelingProjectOverview:
      properties:
        createdAt:
          description: Time when project was created
          format: date-time
          type: string
        datasetName:
          description: Name of default dataset
          type: string
        name:
          description: Name of the project
          type: string
        numberOfModels:
          description: Number of the models in the project
          nullable: true
          type: integer
        owner:
          description: Name of the modeling project owner
          nullable: true
          type: string
        targetName:
          description: Name of modeling target
          type: string
        useCase:
          $ref: '#/components/schemas/UseCaseInfo'
          description: Information about the Use Case that this modeling project is
            attached to
          nullable: true
          x-versionadded: v2.33
      required:
      - createdAt
      - datasetName
      - name
      - numberOfModels
      - owner
      - targetName
      type: object
    ValueTrackerAttachmentResponse:
      properties:
        attachedObjectId:
          description: The id of the attached object
          type: string
        canView:
          description: Indicates if user has view access to the attached object
          type: boolean
        id:
          description: The id of the class ValueTracker
          type: string
        isAccessRequested:
          description: Indicates if user has requested access to the attached object
          type: boolean
        overview:
          description: Detailed information depending on the type of the attachment
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentOverview'
          - $ref: '#/components/schemas/ValueTrackerAttachmentDatasetOverview'
          - $ref: '#/components/schemas/ValueTrackerAttachmentModelingProjectOverview'
          - $ref: '#/components/schemas/ValueTrackerAttachmentCustomModelOverview'
          - $ref: '#/components/schemas/ValueTrackerAttachmentModelPackageOverview'
          - $ref: '#/components/schemas/ValueTrackerAttachmentApplicationOverview'
        type:
          description: class ValueTracker attachment type
          enum:
          - dataset
          - modelingProject
          - deployment
          - customModel
          - modelPackage
          - application
          type: string
        useCaseId:
          description: The id of the class ValueTracker
          type: string
      required:
      - attachedObjectId
      - canView
      - id
      - isAccessRequested
      - overview
      - type
      - useCaseId
      type: object
    ValueTrackerBucket:
      properties:
        period:
          $ref: '#/components/schemas/ValueTrackerBucketPeriod'
          description: A `period` object describing the time this bucket covers
        predictionsCount:
          description: Total number of predictions that happened in this bucket
          type: integer
        realizedValue:
          description: Total amount of value realised during this bucket
          type: integer
      required:
      - period
      - predictionsCount
      type: object
    ValueTrackerBucketPeriod:
      properties:
        end:
          description: RFC3339 datetime. End of time period to retrieve.
          format: date-time
          type: string
        start:
          description: RFC3339 datetime. Start of time period to retrieve.
          format: date-time
          type: string
      required:
      - end
      - start
      type: object
    ValueTrackerCreateResponse:
      properties:
        accuracyHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          description: The health of the accuracy
          nullable: true
        businessImpact:
          description: Expected effects on overall business operations
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        commentId:
          description: The id for this comment
          type: string
        content:
          description: A string
          type: string
        description:
          description: class ValueTracker description
          type: string
        feasibility:
          description: Assessment of how the class ValueTracker can be accomplished
            across multiple dimensions
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        id:
          description: The id of the class ValueTracker
          type: string
        inProductionWarning:
          description: An optional warning to indicate that deployments are attached
            to this class ValueTracker.
          nullable: true
          type: string
        mentions:
          description: A list of user objects
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        modelHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          description: The health of the model
          nullable: true
        name:
          description: Name of the class ValueTracker
          type: string
        notes:
          description: User notes
          nullable: true
          type: string
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
          description: User case owner
          nullable: true
        permissions:
          description: Permissions of current user
          items:
            type: string
          nullable: true
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          description: Optional, Contains Template type and parameter information
          nullable: true
        predictionTargets:
          description: An array of strings prediction target names
          items:
            description: The name of the prediction target
            type: string
          type: array
        predictionsCount:
          anyOf:
          - type: string
          - type: integer
          - description: A list of prediction counts.
            items:
              type: integer
            nullable: true
            type: array
          description: Count of the number of predictions made.
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        serviceHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          description: The health of the service
          nullable: true
        stage:
          description: Current stage of class ValueTracker
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: Array of TargetDate objects
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          nullable: true
          type: array
      type: object
    ValueTrackerDrUserId:
      properties:
        firstName:
          description: First name of class ValueTracker owner
          nullable: true
          type: string
        id:
          description: The DR user ID
          type: string
        lastName:
          description: Last of class ValueTracker owner
          nullable: true
          type: string
        username:
          description: Username of class ValueTracker owner
          type: string
      required:
      - id
      type: object
    ValueTrackerEventDescriptions:
      properties:
        businessImpact:
          description: Expected effects on overall business operations
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        commentId:
          description: The id for this comment
          type: string
        content:
          description: A string
          type: string
        description:
          description: class ValueTracker description
          nullable: true
          type: string
        feasibility:
          description: Assessment of how the class ValueTracker can be accomplished
            across multiple dimensions
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        id:
          description: The id of this description item
          nullable: true
          type: string
        mentions:
          description: A list of user objects
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        name:
          description: The name of this event item
          nullable: true
          type: string
        notes:
          description: User notes
          nullable: true
          type: string
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
          description: User case owner
          nullable: true
        permissions:
          description: Permissions of current user
          items:
            type: string
          nullable: true
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          description: Optional, Contains Template type and parameter information
          nullable: true
        predictionTargets:
          description: An array of strings prediction target names
          items:
            description: The name of the prediction target
            type: string
          type: array
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        stage:
          description: Current stage of class ValueTracker
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: Array of TargetDate objects
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          nullable: true
          type: array
      type: object
    ValueTrackerHealthInformation:
      properties:
        endDate:
          description: The end date for this health status
          format: date-time
          nullable: true
          type: string
        message:
          description: Information about the health status
          nullable: true
          type: string
        startDate:
          description: The start date for this health status
          format: date-time
          nullable: true
          type: string
        status:
          description: The status of the class ValueTracker
          nullable: true
          type: string
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    ValueTrackerListResponse:
      properties:
        count:
          description: The number of items returned on this page
          type: integer
        data:
          description: A list of the class ValueTrackers that match the query
          items:
            $ref: '#/components/schemas/ValueTrackerResponse'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The number of items matching the query condition
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ValueTrackerMonetaryValue:
      properties:
        currency:
          description: ISO code of currency
          enum:
          - BRL
          - EUR
          - GBP
          - JPY
          - KRW
          - UAH
          - USD
          type: string
        details:
          description: Optional user notes
          nullable: true
          type: string
        value:
          description: Amount of value
          type: number
      required:
      - currency
      - value
      type: object
    ValueTrackerRealizedValuesOverTimeResponse:
      properties:
        buckets:
          description: An array of `bucket` objects representing prediction totals
            and realized value over time
          items:
            $ref: '#/components/schemas/ValueTrackerBucket'
          type: array
        previousTimeRangeSummary:
          $ref: '#/components/schemas/ValueTrackerSummary'
          description: A `summary` object covering the time range before the given
            one with the same duration
        summary:
          $ref: '#/components/schemas/ValueTrackerSummary'
          description: A `summary` object covering the given time range
      required:
      - buckets
      - previousTimeRangeSummary
      - summary
      type: object
    ValueTrackerResponse:
      properties:
        accuracyHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          description: The health of the accuracy
          nullable: true
        businessImpact:
          description: Expected effects on overall business operations
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        commentId:
          description: The id for this comment
          type: string
        content:
          description: A string
          type: string
        description:
          description: class ValueTracker description
          nullable: true
          type: string
        feasibility:
          description: Assessment of how the class ValueTracker can be accomplished
            across multiple dimensions
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        id:
          description: The id of the class ValueTracker
          type: string
        inProductionWarning:
          description: An optional warning to indicate that deployments are attached
            to this class ValueTracker.
          nullable: true
          type: string
        mentions:
          description: A list of user objects
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        modelHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          description: The health of the model
          nullable: true
        name:
          description: Name of the class ValueTracker
          type: string
        notes:
          description: User notes
          nullable: true
          type: string
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
          description: User case owner
          nullable: true
        permissions:
          description: Permissions of current user
          items:
            type: string
          nullable: true
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          description: Optional, Contains Template type and parameter information
          nullable: true
        predictionTargets:
          description: An array of strings prediction target names
          items:
            description: The name of the prediction target
            type: string
          type: array
        predictionsCount:
          anyOf:
          - type: string
          - type: integer
          - description: A list of prediction counts.
            items:
              type: integer
            nullable: true
            type: array
          description: Count of the number of predictions made.
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Optional, Contains MonetaryValue objects
          nullable: true
        serviceHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          description: The health of the service
          nullable: true
        stage:
          description: Current stage of class ValueTracker
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: Array of TargetDate objects
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          nullable: true
          type: array
      type: object
    ValueTrackerSharingListData:
      properties:
        id:
          description: The ID of the recipient
          type: string
        name:
          description: The name of the user, group, or organization
          type: string
        role:
          description: The assigned role
          enum:
          - OWNER
          - USER
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type
          enum:
          - user
          - group
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    ValueTrackerSharingListResponse:
      properties:
        count:
          description: The number of items returned on this page
          type: integer
        data:
          description: A list of sharing role objects
          items:
            $ref: '#/components/schemas/ValueTrackerSharingListData'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          nullable: true
          type: string
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          nullable: true
          type: string
        totalCount:
          description: The number of items matching the query condition
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ValueTrackerSharingRoleUpdateData:
      properties:
        id:
          description: The ID of the recipient
          type: string
        role:
          description: The assigned role
          enum:
          - OWNER
          - USER
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type
          enum:
          - user
          - group
          - organization
          type: string
        username:
          description: The name of the user, group, or organization
          type: string
      required:
      - role
      - shareRecipientType
      type: object
    ValueTrackerSharingUpdate:
      properties:
        operation:
          description: The name of the action being taken. Only 'updateRoles' is supported.
          enum:
          - updateRoles
          type: string
        roles:
          description: A list of sharing role objects
          items:
            $ref: '#/components/schemas/ValueTrackerSharingRoleUpdateData'
          type: array
      required:
      - operation
      - roles
      type: object
    ValueTrackerSummary:
      properties:
        averagePredictionsCount:
          description: Average number of predictions per bucket during this time period
          type: integer
        averageRealizedValue:
          description: Average amount of value per bucket realised during this time
            period
          type: integer
        period:
          $ref: '#/components/schemas/ValueTrackerBucketPeriod'
          description: A `period` object describing the time this bucket covers
        totalPredictionsCount:
          description: Total number of predictions that happened during this time
            period
          type: integer
        totalRealizedValue:
          description: Total amount of value realised during this time period
          type: integer
      required:
      - averagePredictionsCount
      - period
      - totalRealizedValue
      type: object
    ValueTrackerTargetDate:
      properties:
        date:
          description: Date of the target
          format: date-time
          type: string
        stage:
          description: Name of the target stage
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
      required:
      - date
      - stage
      type: object
    ValueTrackerUpdate:
      properties:
        businessImpact:
          description: Expected effects on overall business operations
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        description:
          description: class ValueTracker description
          maxLength: 1024
          nullable: true
          type: string
        feasibility:
          description: Assessment of how the class ValueTracker can be accomplished
            across multiple dimensions
          maximum: 5
          minimum: 1
          nullable: true
          type: integer
        name:
          description: Name of the class ValueTracker
          maxLength: 512
          type: string
        notes:
          description: User notes
          maxLength: 1024
          nullable: true
          type: string
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
          description: User case owner
          nullable: true
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Contains MonetaryValue objects
          nullable: true
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          description: Contains Template type and parameter information defined in
            the response of :http:get:`/api/v2/valueTrackerValueTemplates/(templateType)/calculation/`
          nullable: true
        predictionTargets:
          description: An array of strings prediction target names
          items:
            type: string
          nullable: true
          type: array
        realizedValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          description: Contains MonetaryValue objects
          nullable: true
        stage:
          description: Current stage of class ValueTracker
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: Array of TargetDate objects
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          nullable: true
          type: array
      type: object
    ValueTrackerValueCalculateTemplate:
      properties:
        data:
          description: Data used for calculating the result
          oneOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassificationData'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegressionData'
        templateType:
          description: The name of the class ValueTracker value template
          enum:
          - classification
          - regression
          type: string
      required:
      - data
      - templateType
      type: object
    ValueTrackerValueTemplateCalculateResponse:
      properties:
        averageValuePerDecision:
          description: Estimated average value per decision
          type: number
        savedAnnually:
          description: Estimated amount saved annually
          type: number
        template:
          $ref: '#/components/schemas/ValueTrackerValueCalculateTemplate'
          description: Template type and data used for calculating the result
      required:
      - averageValuePerDecision
      - savedAnnually
      - template
      type: object
    ValueTrackerValueTemplateClassification:
      properties:
        data:
          $ref: '#/components/schemas/ValueTrackerValueTemplateClassificationData'
          description: class ValueTracker value data
        templateType:
          description: class ValueTracker value template type
          enum:
          - classification
          type: string
      required:
      - data
      - templateType
      type: object
    ValueTrackerValueTemplateClassificationData:
      properties:
        accuracyImprovement:
          description: Accuracy improvement
          type: number
        decisionsCount:
          description: Estimated number of decisions per year
          type: integer
        incorrectDecisionCost:
          description: Estimated cost of an individual incorrect decision
          type: number
        incorrectDecisionsCount:
          description: Estimated number of incorrect decisions per year
          type: integer
      required:
      - accuracyImprovement
      - decisionsCount
      - incorrectDecisionCost
      - incorrectDecisionsCount
      type: object
    ValueTrackerValueTemplateParameterWithSchema:
      properties:
        parameterName:
          description: Name of the parameter
          type: string
        schema:
          $ref: '#/components/schemas/ValueTrackerValueTemplateSchema'
          description: Schema entry defining the type and limits of a template parameter
      required:
      - parameterName
      - schema
      type: object
    ValueTrackerValueTemplateRegression:
      properties:
        data:
          $ref: '#/components/schemas/ValueTrackerValueTemplateRegressionData'
          description: class ValueTracker value data
        templateType:
          description: class ValueTracker value template type
          enum:
          - regression
          type: string
      required:
      - data
      - templateType
      type: object
    ValueTrackerValueTemplateRegressionData:
      properties:
        accuracyImprovement:
          description: Accuracy improvement
          type: number
        decisionsCount:
          description: Estimated number of decisions per year
          type: integer
        targetValue:
          description: Target value
          type: number
      required:
      - accuracyImprovement
      - decisionsCount
      - targetValue
      type: object
    ValueTrackerValueTemplateResponse:
      properties:
        description:
          description: Description of Value Template
          type: string
        schema:
          description: Schema definition of all template parameters
          items:
            $ref: '#/components/schemas/ValueTrackerValueTemplateParameterWithSchema'
          type: array
        templateType:
          description: The name of the class ValueTracker value template to be retrieved
          enum:
          - classification
          - regression
          type: string
        title:
          description: Title of Value Template
          type: string
      required:
      - description
      - schema
      - templateType
      - title
      type: object
    ValueTrackerValueTemplateSchema:
      properties:
        elementType:
          description: Possible types used for template variables
          enum:
          - integer
          - float
          - number
          type: string
        label:
          description: Label describing the represented value
          type: string
        maximum:
          description: Sets Maximum value if given
          nullable: true
          type: integer
        minimum:
          description: Sets Minimum value if given
          nullable: true
          type: integer
        placeholder:
          description: Text that can be used to prefill an input filed for the value
          type: string
        unit:
          description: Unit type. e.g. %
          nullable: true
          type: string
      required:
      - elementType
      - label
      - maximum
      - minimum
      - placeholder
      - unit
      type: object
    VersionRetrieveResponse:
      properties:
        major:
          description: The major version number.
          type: integer
        minor:
          description: The minor version number.
          type: integer
        versionString:
          description: The full version string.
          type: string
      required:
      - major
      - minor
      - versionString
      type: object
    VertexContextItem:
      properties:
        information:
          description: A specification of requirements of the inputs and expectations
            of the output of the vertex.
          oneOf:
          - $ref: '#/components/schemas/VertexContextItemInfo'
        messages:
          description: Warnings about and errors with a specific vertex in the blueprint.
          oneOf:
          - $ref: '#/components/schemas/VertexContextItemMessages'
        taskId:
          description: The id associated with a specific vertex in the blueprint.
          type: string
      required:
      - taskId
      type: object
    VertexContextItemInfo:
      properties:
        inputs:
          description: A specification of requirements of the inputs of the vertex.
          items:
            type: string
          type: array
        outputs:
          description: A specification of expectations of the output of the vertex.
          items:
            type: string
          type: array
      required:
      - inputs
      - outputs
      type: object
    VertexContextItemMessages:
      properties:
        errors:
          description: Errors with a specific vertex in the blueprint. Execution of
            the vertex is expected to fail.
          items:
            type: string
          type: array
        warnings:
          description: Warnings about a specific vertex in the blueprint. Execution
            of the vertex may fail or behave unexpectedly.
          items:
            type: string
          type: array
      type: object
    Warnings:
      properties:
        action:
          description: Suggested action to fix the relationship
          nullable: true
          type: string
        category:
          description: Class of the warning about an aspect of the relationship
          enum:
          - green
          - yellow
          type: string
        message:
          description: Warning message about an aspect of the relationship
          type: string
      required:
      - action
      - category
      - message
      type: object
    WordCloudNgram:
      properties:
        class:
          description: For classification - values of the target class for corresponding
            word or ngram. For regression - null.
          nullable: true
          type: string
        coefficient:
          description: Describes effect of this ngram on the target. A large negative
            value means a strong effect toward the negative class in classification
            projects and a smaller predicted target value in regression projects.
            A large positive value means a strong effect toward the positive class
            and a larger predicted target value respectively.
          maximum: 1
          minimum: -1
          type: number
        count:
          description: Number of rows in the training sample where this ngram appears.
          type: integer
        frequency:
          description: Frequency of this ngram relative to the most common ngram.
          exclusiveMinimum: true
          maximum: 1
          minimum: 0
          type: number
        isStopword:
          description: True for ngrams that DataRobot evaluates as stopwords.
          type: boolean
        ngram:
          description: Word or ngram value.
          type: string
        variable:
          description: String representation of the ngram source - contains column
            name and, for some models, preprocessing details. E.g. NGRAM_OCCUR_L2_colname
            will be for ngram occurrences count using L2 normalization from the colname
            column.
          type: string
          x-versionadded: v2.19
      required:
      - coefficient
      - count
      - frequency
      - isStopword
      - ngram
      - variable
      type: object
    WordCloudRetrieveResponse:
      properties:
        ngrams:
          description: A list of dictionaries containing information about the most
            important ngrams.
          items:
            $ref: '#/components/schemas/WordCloudNgram'
          type: array
      required:
      - ngrams
      type: object
    WorkspaceItemResponse:
      properties:
        commitSha:
          description: SHA1 hash pointing to the original file revision (set only
            for files pulled from Git-like repositories).
          nullable: true
          type: string
        created:
          description: ISO-8601 timestamp of when the file item was created.
          type: string
        fileName:
          description: Name of the file item.
          type: string
        filePath:
          description: Path of the file item.
          type: string
        fileSource:
          description: Source of the file item.
          type: string
        id:
          description: ID of the file item.
          type: string
        ref:
          description: Remote reference (branch, commit, tag). Branch "master", if
            not specified.
          nullable: true
          type: string
        repositoryFilePath:
          description: Full path to the file in the remote repository.
          nullable: true
          type: string
        repositoryLocation:
          description: URL to remote repository from which the file was pulled (e.g.
            Git server or S3 Bucket name).
          nullable: true
          type: string
        repositoryName:
          description: Name of the repository from which the file was pulled.
          nullable: true
          type: string
      required:
      - created
      - fileName
      - filePath
      - fileSource
      - id
      type: object
    WorkspaceSourceCreatedResponse:
      properties:
        workspaceStateId:
          description: ID of the Data Engine workspace state.
          type: string
      required:
      - workspaceStateId
      type: object
    WorkspaceSourceDatasetWithCredsResponse:
      properties:
        alias:
          description: Alias to be used as the table name.
          type: string
        datasetId:
          description: ID of a dataset in the catalog.
          type: string
        datasetVersionId:
          description: ID of a dataset version in the catalog.
          type: string
        needsCredentials:
          description: Whether a user must provide credentials for source datasets.
          type: boolean
      required:
      - alias
      - datasetId
      - datasetVersionId
      - needsCredentials
      type: object
    WorkspaceStateCreatedFromQueryGeneratorResponse:
      properties:
        datasets:
          description: Source datasets in the Data Engine workspace.
          items:
            $ref: '#/components/schemas/DataEngineDataset'
          type: array
        language:
          description: Language of the Data Engine query.
          type: string
        query:
          description: Actual body of the Data Engine query.
          type: string
        queryGeneratorId:
          description: Query generator id.
          nullable: true
          type: string
        workspaceStateId:
          description: Data Engine workspace state ID.
          type: string
      required:
      - datasets
      - language
      - query
      - queryGeneratorId
      - workspaceStateId
      type: object
    WorkspaceStateResponse:
      properties:
        datasets:
          description: Source datasets in the Data Engine workspace.
          items:
            $ref: '#/components/schemas/WorkspaceSourceDatasetWithCredsResponse'
          type: array
        language:
          description: Language of the Data Engine query.
          type: string
        query:
          description: Actual body of the Data Engine query.
          type: string
        queryGeneratorId:
          description: Query generator id.
          nullable: true
          type: string
        runTime:
          description: Data Engine query execution time.
          nullable: true
          type: number
      required:
      - datasets
      - language
      - query
      - queryGeneratorId
      - runTime
      type: object
    WranglerRecipeDataStreamer:
      properties:
        recipeId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the wrangler recipe holding information about the
              input data for the Snowflake JDBC connection.
            type: string
          - enum:
            - '[redacted]'
            type: string
        type:
          description: Type name for this intake type
          enum:
          - recipe
          type: string
      required:
      - recipeId
      - type
      type: object
    WranglerRecipeIntake:
      properties:
        recipeId:
          description: The ID of the wrangler recipe holding information about the
            input data for the Snowflake JDBC connection.
          type: string
        type:
          description: Type name for this intake type
          enum:
          - recipe
          type: string
      required:
      - recipeId
      - type
      type: object
    WranglingFeatureResponse:
      properties:
        datasetId:
          description: The ID of the dataset the feature belongs to
          type: string
          x-versionadded: v2.33
        datasetVersionId:
          description: The ID of the dataset version the feature belongs to.
          type: string
          x-versionadded: v2.33
        dateFormat:
          description: The date format string for how this feature was interpreted
            (or null if not a date feature). If not null, it will be compatible with
            https://docs.python.org/2/library/time.html#time.strftime .
          nullable: true
          type: string
          x-versionadded: v2.33
        featureType:
          description: Feature type.
          enum:
          - Boolean
          - Categorical
          - Currency
          - Date
          - Date Duration
          - Document
          - Image
          - Interaction
          - Length
          - Location
          - Multicategorical
          - Numeric
          - Percentage
          - Summarized Categorical
          - Text
          - Time
          type: string
          x-versionadded: v2.33
        id:
          description: The number of the column in the dataset.
          type: integer
          x-versionadded: v2.33
        isZeroInflated:
          description: whether feature has an excessive number of zeros
          nullable: true
          type: boolean
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            description: For a Summarized Categorical columns, this will contain statistics
              for the top 50 keys (truncated to 103 characters)
            x-versionadded: v2.18
          - description: For a Multicategorical columns, this will contain statistics
              for the top classes
            items:
              $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorMultilabel'
            type: array
            x-versionadded: v2.24
          x-versionadded: v2.33
        language:
          description: Detected language of the feature.
          type: string
          x-versionadded: v2.32
        lowInformation:
          description: Whether feature has too few values to be informative.
          type: boolean
          x-versionadded: v2.33
        majorityClassCount:
          description: The number of rows with a majority class value if smart downsampling
            is applicable to this feature.
          nullable: true
          type: integer
          x-versionadded: v2.33
        max:
          description: Maximum value of the EDA sample of the feature.
          nullable: true
          type: number
          x-versionadded: v2.33
        mean:
          description: Arithmetic mean of the EDA sample of the feature.
          nullable: true
          type: number
          x-versionadded: v2.33
        median:
          description: Median of the EDA sample of the feature.
          nullable: true
          type: number
          x-versionadded: v2.33
        min:
          description: Minimum value of the EDA sample of the feature.
          nullable: true
          type: number
          x-versionadded: v2.33
        minorityClassCount:
          description: The number of rows with neither null nor majority class value
            if smart downsampling is applicable to this feature.
          nullable: true
          type: integer
          x-versionadded: v2.33
        naCount:
          description: Number of missing values.
          nullable: true
          type: integer
          x-versionadded: v2.33
        name:
          description: Feature name
          type: string
          x-versionadded: v2.33
        plot:
          description: Plot data based on feature values.
          items:
            $ref: '#/components/schemas/DatasetFeaturePlotDataResponse'
          nullable: true
          type: array
          x-versionadded: v2.30
        stdDev:
          description: Standard deviation of EDA sample of the feature.
          nullable: true
          type: number
          x-versionadded: v2.33
        timeSeriesEligibilityReason:
          description: why the feature is ineligible for time series projects, or
            'suitable' if it is eligible.
          nullable: true
          type: string
          x-versionadded: v2.33
        timeSeriesEligibilityReasonAggregation:
          description: why the feature is ineligible for aggregation, or 'suitable'
            if it is eligible.
          nullable: true
          type: string
          x-versionadded: v2.24
        timeSeriesEligible:
          description: whether this feature can be used as a datetime partitioning
            feature for time series projects.  Only sufficiently regular date features
            can be selected as the datetime feature for time series projects.  Always
            false for non-date features. Date features that cannot be used in datetime
            partitioning for a time series project may be eligible for an OTV project,
            which has less stringent requirements.
          type: boolean
          x-versionadded: v2.33
        timeSeriesEligibleAggregation:
          description: whether this feature can be used as a datetime feature for
            aggregationfor time series data prep.  Always false for non-date features.
          type: boolean
          x-versionadded: v2.24
        timeStep:
          description: The minimum time step that can be used to specify time series
            windows.  The units for this value are the ``timeUnit``.  When specifying
            windows for time series projects, all windows must have durations that
            are integer multiples of this number. Only present for date features that
            are eligible for time series projects and null otherwise.
          nullable: true
          type: integer
          x-versionadded: v2.33
        timeStepAggregation:
          description: The minimum time step that can be used to aggregate using this
            feature for time series data prep. The units for this value are the ``timeUnit``.  Only
            present for date features that are eligible for aggregation in time series
            data prep and null otherwise.
          nullable: true
          type: integer
          x-versionadded: v2.24
        timeUnit:
          description: The unit for the interval between values of this feature, e.g.
            DAY, MONTH, HOUR.  When specifying windows for time series projects, the
            windows are expressed in terms of this unit.  Only present for date features
            eligible for time series projects, and null otherwise.
          nullable: true
          type: string
          x-versionadded: v2.33
        timeUnitAggregation:
          description: The unit for the interval between values of this feature, e.g.
            DAY, MONTH, HOUR.  Only present for date features eligible for aggregation,
            and null otherwise.
          nullable: true
          type: string
          x-versionadded: v2.24
        uniqueCount:
          description: Number of unique values.
          nullable: true
          type: integer
          x-versionadded: v2.33
      required:
      - datasetId
      - datasetVersionId
      - dateFormat
      - featureType
      - id
      - majorityClassCount
      - minorityClassCount
      - name
      type: object
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
info:
  contact:
    email: support@datarobot.com
    name: DataRobot Support
    url: https://support.datarobot.com
  description: DataRobot's Public facing API
  license:
    name: DataRobot Tool and Utility Agreement
    url: https://www.datarobot.com/wp-content/uploads/2021/07/DataRobot-Tool-and-Utility-Agreement.pdf
  title: Public API
  version: 2.33.0
  x-datarobot-release-version: null
openapi: 3.0.3
paths:
  /api/v2/applications/:
    get:
      description: Paginated list of applications created by the currently authenticated
        user.
      operationId: applications_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of the application
        in: query
        name: lid
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationList'
          description: ''
      summary: Paginated list of applications created by the currently authenticated
        user.
      tags:
      - applications
      x-versionadded: v2.21
    post:
      description: Create an application. Note that the number of active applications
        users can have at the same time is limited.
      operationId: applications_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
          description: ''
        '202':
          description: Creation has successfully started. See the Location header.
        '403':
          description: User does not have permission to launch application of provided
            type.
        '404':
          description: No app type matching the specified identifier found or user
            does not have permissions to access to this app type.
        '422':
          description: Application could not be created with the given input.
      summary: Create an application
      tags:
      - applications
      x-versionadded: v2.21
  /api/v2/applications/verify/:
    post:
      description: Verifies a user can create an app
      operationId: applicationsVerify_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationCanCreate'
      responses:
        '200':
          description: App may be created
        '403':
          description: User does not have permission to launch application of provided
            type.
        '404':
          description: No app type matching the specified identifier found or user
            does not have permissions to access to this app type.
        '422':
          description: Application can not be created with the given input.
      summary: Verify ability to create an application
      tags:
      - applications
      x-versionadded: v2.32
  /api/v2/applications/{applicationId}/:
    delete:
      description: Delete an application
      operationId: applications_delete
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationParam'
      responses:
        '200':
          description: ''
        '204':
          description: The application has been deleted.
      summary: Delete an application
      tags:
      - applications
      x-versionadded: v2.21
    get:
      description: Retrieve an application
      operationId: applications_retrieve
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationRetrieve'
          description: ''
      summary: Retrieve an application
      tags:
      - applications
      x-versionadded: v2.21
    patch:
      description: Update an application's name and/or description
      operationId: applications_patch
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationNameAndDescription'
      responses:
        '200':
          description: ''
        '204':
          description: The application has been updated.
      summary: Update an application's name and/or description
      tags:
      - applications
      x-versionadded: v2.21
  /api/v2/applications/{applicationId}/accessControl/:
    get:
      description: A list of users who have access to this application and their roles
      operationId: applicationsAccessControl_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Optional, only return the access control information for a user
          with this username.
        in: query
        name: username
        required: false
        schema:
          type: string
      - description: Optional, only return the access control information for a user
          with this user ID.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAccessControlList'
          description: ''
        '400':
          description: Bad Request, both username and userId were specified
        '404':
          description: Entity not found. Either the application does not exist or
            the user does not have permissions to view the application.
      summary: A list of users with access to this application
      tags:
      - applications
      x-versionadded: v2.21
    patch:
      description: Update access control for this application. Request is processed
        only if updates can be performed on all entries.
      operationId: applicationsAccessControl_patchMany
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationAccessControlUpdateRequest'
      responses:
        '200':
          description: ''
        '403':
          description: User does not have appropriate privileges
        '404':
          description: Invalid applicationId provided or invalid username provided
            to modify access for
      summary: Update access control for this application.
      tags:
      - applications
      x-versionadded: v2.21
  /api/v2/applications/{applicationId}/deployments/:
    post:
      description: If application creates deployment during its lifetime, we want
        to have an API to link deployment with application.
      operationId: applicationsDeployments_create
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDeploymentToApplication'
      responses:
        '200':
          description: ''
      summary: Links a deployment to an application
      tags:
      - applications
      x-versionadded: v2.21
  /api/v2/applications/{applicationId}/deployments/{modelDeploymentId}/:
    delete:
      description: Delete link between application and deployment.
      operationId: applicationsDeployments_delete
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      - description: The ID of the model deployment
        in: path
        name: modelDeploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationModelDeploymentParam'
      responses:
        '200':
          description: ''
        '204':
          description: The link has been deleted.
      summary: Delete link between application and deployment.
      tags:
      - applications
      x-versionadded: v2.21
  /api/v2/applications/{applicationId}/duplicate/:
    post:
      description: Create a copy of App Builder application. Note that the number
        of active applications users can have at the same time is limited.
      operationId: applicationsDuplicate_create
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationDuplicate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
          description: ''
        '202':
          description: Dulication has successfully started. See the Location header.
        '403':
          description: User does not have permission to launch application of provided
            type.
        '404':
          description: App for duplication was not found
        '422':
          description: Application could not be created with the given input.
      summary: Create a duplicate of the application
      tags:
      - applications
      x-versionadded: v2.27.0
  /api/v2/applications/{applicationId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations that have an access
        to this application
      operationId: applicationsSharedRoles_list
      parameters:
      - description: The number of records to return in the range of 1 to 100
        in: query
        name: limit
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          type: integer
      - description: Only return roles for a user, group or organization with this
          name
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Only return roles for a user, group or organization with this
          id
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Specify the recipient type, one of 'user', 'group', 'organization'
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSharedRolesList'
          description: ''
      summary: Get a list of users, groups and organizations that have an access to
        this application
      tags:
      - applications
      x-versionadded: v2.22
    patch:
      description: Share an application with a user, group, or organization
      operationId: applicationsSharedRoles_patchMany
      parameters:
      - description: Send a notification
        in: query
        name: sendNotification
        required: true
        schema:
          default: false
          type: boolean
      - description: A note to go with the project share
        in: query
        name: note
        required: true
        schema:
          type: string
      - description: Name of the action being taken, only 'updateRoles' is supported
        in: query
        name: operation
        required: true
        schema:
          type: string
      - description: Role objects, may contain up to 100 per request
        in: query
        name: roles
        required: true
        schema:
          items:
            $ref: '#/components/schemas/ApplicationSharedRolesEntryUpdate'
          maxItems: 100
          type: array
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationSharingUpdateOrRemove'
      responses:
        '200':
          description: ''
        '204':
          description: The roles updated successfully
        '422':
          description: The request was formatted improperly.
      summary: Share an application with a user, group, or organization
      tags:
      - applications
      x-versionadded: v2.22
  /api/v2/applications/{applicationId}/userRole/:
    get:
      description: Get application user role
      operationId: applicationUserRole_retrieve
      parameters:
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationUserRoleResponse'
          description: user's role on application entity, taking into account RBAC,
            groups and organization.
      summary: Get application user role
      tags:
      - applications
      x-versionadded: v2.24
  /api/v2/approvalPolicies/:
    get:
      description: List Approval Policies.
      operationId: approvalPolicies_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Type of entity to filter policies by.
        in: query
        name: entityType
        required: false
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - deploymentModel
          - DeploymentModel
          - DEPLOYMENT_MODEL
          - deploymentConfig
          - DeploymentConfig
          - DEPLOYMENT_CONFIG
          - deploymentStatus
          - DeploymentStatus
          - DEPLOYMENT_STATUS
          - deploymentMonitoringData
          - DeploymentMonitoringData
          - DEPLOYMENT_MONITORING_DATA
          type: string
      - description: Part of the policy name to search by.
        in: query
        name: namePart
        required: false
        schema:
          minLength: 1
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalPolicyListResponse'
          description: Approval Policy has been successfully updated.
        '403':
          description: Approval Policy management feature is disabled for the user.
      summary: List Approval Policies.
      tags:
      - governance
      x-versionadded: v2.22
    post:
      description: Create a new Approval Policy.
      operationId: approvalPolicies_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalPolicy'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalPolicyResponse'
          description: Approval Policy has been successfully created.
        '403':
          description: Approval Policy management feature is disabled for the user.
        '422':
          description: Approval Policy could not be created with the given input.
      summary: Create a new Approval Policy.
      tags:
      - governance
      x-versionadded: v2.22
  /api/v2/approvalPolicies/{approvalPolicyId}/:
    delete:
      description: Delete the policy with the given ID.
      operationId: approvalPolicies_delete
      parameters:
      - description: ID of the Approval Policy.
        in: path
        name: approvalPolicyId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Approval Policy has been successfully deleted.
        '403':
          description: Approval Policy management feature is disabled for the user.
        '404':
          description: Approval Policy does not exist or the user doesn't have access
            to it.
      summary: Delete an Approval Policy.
      tags:
      - governance
      x-versionadded: v2.22
    get:
      description: Retrieve the policy with the given ID.
      operationId: approvalPolicies_retrieve
      parameters:
      - description: ID of the Approval Policy.
        in: path
        name: approvalPolicyId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalPolicyResponse'
          description: Approval Policy has been successfully retrieved.
        '403':
          description: Approval Policy management feature is disabled for the user.
        '404':
          description: Approval Policy does not exist or the user doesn't have access
            to it.
      summary: Retrieve an Approval Policy.
      tags:
      - governance
      x-versionadded: v2.22
    put:
      description: Update the policy with the given ID.
      operationId: approvalPolicies_put
      parameters:
      - description: ID of the Approval Policy.
        in: path
        name: approvalPolicyId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalPolicy'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalPolicyResponse'
          description: Approval Policy has been successfully updated.
        '403':
          description: Approval Policy management feature is disabled for the user.
        '404':
          description: Approval Policy does not exist or the user doesn't have access
            to it.
        '422':
          description: Approval Policy could not be created with the given input.
      summary: Update an Approval Policy.
      tags:
      - governance
      x-versionadded: v2.22
  /api/v2/approvalPolicies/{approvalPolicyId}/shareableChangeRequests/:
    get:
      description: Get information about Change Requests submitted for a certain Approval
        Policy.
      operationId: approvalPoliciesShareableChangeRequests_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Attribute to order Change Requests by.
        in: query
        name: orderBy
        required: false
        schema:
          default: ''
          type: string
      - description: ID of the Approval Policy.
        in: path
        name: approvalPolicyId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRequestInfoListResponse'
          description: Change Requests information has been successfully retrieved.
        '403':
          description: Approval Policy management feature is disabled for the user.
        '404':
          description: Approval Policy does not exist or the user doesn't have access
            to it.
      summary: Retrieve associated Change Requests Info.
      tags:
      - governance
      x-versionadded: v2.22
  /api/v2/approvalPolicyMatch/:
    get:
      description: Get policy ID matching the query
      operationId: approvalPolicyMatch_list
      parameters:
      - description: Searched typed of the entity.
        in: query
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - deploymentModel
          - DeploymentModel
          - DEPLOYMENT_MODEL
          - deploymentConfig
          - DeploymentConfig
          - DEPLOYMENT_CONFIG
          - deploymentStatus
          - DeploymentStatus
          - DEPLOYMENT_STATUS
          - deploymentMonitoringData
          - DeploymentMonitoringData
          - DEPLOYMENT_MONITORING_DATA
          type: string
      - description: Searched policy action.
        in: query
        name: action
        required: true
        schema:
          enum:
          - create
          - Create
          - CREATE
          - update
          - Update
          - UPDATE
          - delete
          - Delete
          - DELETE
          type: string
      - description: Name of the entity field to filter policies by.
        in: query
        name: fieldName
        required: false
        schema:
          maxLength: 50
          nullable: true
          type: string
      - description: Value of the entity field to filter policies by.
        in: query
        name: fieldValue
        required: false
        schema:
          maxLength: 50
          nullable: true
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalPolicyMatchResponse'
          description: Search executed successfully.
        '403':
          description: Approval Policy management feature is disabled for the user.
      summary: Get policy ID matching the query
      tags:
      - governance
      x-versionadded: v2.22
  /api/v2/approvalPolicyTriggers/:
    get:
      description: Get a list of available policy triggers.
      operationId: approvalPolicyTriggers_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalWorkflowListTriggerResponse'
          description: The list of triggers is successfully generated.
        '403':
          description: Approval Policy management feature is disabled for the user.
      summary: Get a list of available policy triggers.
      tags:
      - governance
      x-versionadded: v2.22
  /api/v2/automatedDocumentOptions/:
    get:
      description: Check which document types and locales are available for generation
        with your account.
      operationId: automatedDocumentOptions_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomatedDocOptionsResponse'
          description: Available document types and locales retrieved.
      summary: List all available document types and locales.
      tags:
      - documentation
      x-versionadded: v2.24
  /api/v2/automatedDocuments/:
    get:
      description: "\nGet information about all previously generated documents available\
        \ for your account. The\ninformation includes document ID and type, ID of\
        \ the entity it was generated for, time of\ncreation, and other information.\n\
        \nExample request to get a list of all documents:\n\n.. code-block:: text\n\
        \n    GET https://app.datarobot.com/api/v2/automatedDocuments/ HTTP/1.1\n\
        \    Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4\n\nQuery for specific\
        \ documents. For example, request a list of documents\ngenerated for a specific\
        \ model in ``docx`` and ``html`` formats:\n\n.. code-block:: text\n\n    GET\
        \ https://app.datarobot.com/api/v2/automatedDocuments?entityId=\n    5ec4ea7e41054c158c5b002f&outputFormat=docx&outputFormat=html\
        \ HTTP/1.1\n    Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4\n\n\
        In response body, you will get a page with queried documents. This is an example\
        \ response\nwith one document returned:\n\n.. code-block:: json\n\n    {\n\
        \        \"totalCount\": 1,\n        \"count\": 1,\n        \"previous\":\
        \ null,\n        \"next\": null,\n        \"data\": [\n            {\n   \
        \             \"id\": \"5ebdb5e911a5fb85edff2b3c\",\n                \"documentType\"\
        : \"MODEL_COMPLIANCE\",\n                \"entityId\": \"5ebbb5e7d9d7b96e3d48e3b5\"\
        ,\n                \"templateId\": \"5bd812e5f750edd392fa880f\",\n       \
        \         \"locale\": \"EN_US\",\n                \"outputFormat\": \"DOCX\"\
        ,\n                \"createdAt\": \"2019-11-07T11:12:13.141516Z\"\n      \
        \      }\n        ]\n    }\n\nIf there are no matching documents, you will\
        \ get a page with an empty data array."
      operationId: automatedDocuments_list
      parameters:
      - description: Number of items to skip. Defaults to 0 if not provided.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of items to return, defaults to 100 if not provided.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          type: integer
      - description: Query for one or more document types.
        in: query
        name: documentType
        required: false
        schema:
          oneOf:
          - enum:
            - AUTOPILOT_SUMMARY
            - MODEL_COMPLIANCE
            - DEPLOYMENT_REPORT
            type: string
            x-enum-versionadded:
            - value: DEPLOYMENT_REPORT
              x-versionadded: v2.24
          - items:
              enum:
              - AUTOPILOT_SUMMARY
              - MODEL_COMPLIANCE
              - DEPLOYMENT_REPORT
              type: string
              x-enum-versionadded:
              - value: DEPLOYMENT_REPORT
                x-versionadded: v2.24
            type: array
      - description: Query for one or more output formats.
        in: query
        name: outputFormat
        required: false
        schema:
          oneOf:
          - enum:
            - docx
            - html
            type: string
          - items:
              enum:
              - docx
              - html
              type: string
            type: array
      - description: Query generated documents by one or more locales.
        in: query
        name: locale
        required: false
        schema:
          oneOf:
          - enum:
            - EN_US
            - JA_JP
            type: string
          - items:
              enum:
              - EN_US
              - JA_JP
              type: string
            type: array
      - description: Query generated documents by one or more entity IDs. For Model
          Compliance docs, the entity ID is a model ID. For Autopilot Summary reports,
          query by project IDs.
        in: query
        name: entityId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomatedDocListResponse'
          description: List of found documents retrieved.
      summary: List all generated documents.
      tags:
      - documentation
      x-versionadded: v2.24
    post:
      description: "\nRequest generation of an automated document that's available\
        \ for your account. Below is an\nexample request body to generate Model Compliance\
        \ documentation:\n\n.. sourcecode:: json\n\n    {\n        \"documentType\"\
        : \"MODEL_COMPLIANCE\",\n        \"entityId\": \"507f191e810c19729de860ea\"\
        ,\n        \"outputFormat\": \"docx\"\n    }\n\nFor Autopilot Summary, set\
        \ a corresponding document type, ``AUTOPILOT_SUMMARY``, and assign a\nneeded\
        \ project ID to the ``entityId`` value.\n\nAfter the request is sent, the\
        \ jobs needed for document generation are queued. You can see the\nstatus\
        \ of the generation by polling the URL in the ``Location`` headers. After\
        \ the generation is\ncomplete, the status URL will automatically redirect\
        \ you to the resource location to download\nthe document.\n\n"
      operationId: automatedDocuments_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomatedDocCreate'
      responses:
        '202':
          description: Document generation request accepted.
          headers:
            Location:
              description: 'URL to poll document generation status: :http:get:`/api/v2/status/(statusId)/`'
              schema:
                type: string
        '422':
          description: Unable to process document generation request.
      summary: Request generation of automated document
      tags:
      - documentation
      x-versionadded: v2.24
  /api/v2/automatedDocuments/{documentId}/:
    delete:
      description: "Delete a document using its ID. Example request:\n\n    .. code-block::\
        \ text\n\n            DELETE https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/\
        \ HTTP/1.1\n            Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4\n\
        \n    "
      operationId: automatedDocuments_delete
      parameters:
      - description: Unique identifier of the generated document.
        in: path
        name: documentId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Document successfully deleted.
        '404':
          description: Provided document ID not found.
      summary: Delete automated document.
      tags:
      - documentation
      x-versionadded: v2.24
    get:
      description: "\nDownload a generated Automated Documentation file.\n\n.. code-block::\
        \ text\n\n    GET https://app.datarobot.com/api/v2/automatedDocuments/5ec4ea7e41054c158c5b002f/\
        \ HTTP/1.1\n    Authorization: Bearer DnwzBUSTOtKBO5Sp1hoUByG4YgZwCCw4\n\n\
        In response, you will get a file containing the generated documentation."
      operationId: automatedDocuments_retrieve
      parameters:
      - description: Unique identifier of the generated document.
        in: path
        name: documentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Download request succeeded.
          headers:
            Content-Disposition:
              description: Autogenerated filename ("attachment;filename=report_name.outputFormat").
              schema:
                type: string
            Content-Type:
              description: MIME type corresponding to document file format
              schema:
                enum:
                - application/vnd.openxmlformats-officedocument.wordprocessingml.document
                - text/html
                type: string
        '404':
          description: Documentation record not found.
      summary: Download generated document.
      tags:
      - documentation
      x-versionadded: v2.24
  /api/v2/batchPredictionJobDefinitions/:
    get:
      description: List all Batch Prediction jobs definitions available
      operationId: batchPredictionJobDefinitions_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 10000
          minimum: 1
          type: integer
      - description: A human-readable name for the definition, must be unique across
          organisations.
        in: query
        name: searchName
        required: false
        schema:
          maxLength: 100
          minLength: 1
          type: string
      - description: Includes only definitions for this particular deployment
        in: query
        name: deploymentId
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobDefinitionsListResponse'
          description: List of all available jobs
        '422':
          description: Your input data or query arguments did not work together
      summary: List Batch Prediction job definitions
      tags:
      - predictions
      x-versionadded: v2.24
    post:
      description: Create a Batch Prediction Job definition. A configuration for a
        Batch Prediction job which can either be executed manually upon request or
        on scheduled intervals, if enabled. The API payload is the same as for `/batchPredictions`
        along with optional ``enabled`` and ``schedule`` items.
      operationId: batchPredictionJobDefinitions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobDefinitionsCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobDefinitionsResponse'
          description: Job details for the created Batch Prediction job definition
        '403':
          description: You are not authorized to create a job definition on this deployment
            due to your permissions role
        '422':
          description: You tried to create a job definition with uncompatible or missing
            parameters to create a fully functioning job definition
      summary: Creates a new Batch Prediction job definition
      tags:
      - predictions
      x-versionadded: v2.24
  /api/v2/batchPredictionJobDefinitions/{jobDefinitionId}/:
    delete:
      description: Delete a Batch Prediction job definition
      operationId: batchPredictionJobDefinitions_delete
      parameters:
      - description: ID of the Batch Prediction job definition
        in: path
        name: jobDefinitionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: You are not authorized to delete this job definition due to
            your permissions role
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
        '409':
          description: Job could not be deleted, as there are currently running jobs
            in the queue.
      summary: Delete Batch Prediction job definition
      tags:
      - predictions
      x-versionadded: v2.24
    get:
      description: Retrieve a Batch Prediction job definition
      operationId: batchPredictionJobDefinitions_retrieve
      parameters:
      - description: ID of the Batch Prediction job definition
        in: path
        name: jobDefinitionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobDefinitionsResponse'
          description: Job details for the requested Batch Prediction job definition
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
      summary: Retrieve Batch Prediction job definition
      tags:
      - predictions
      x-versionadded: v2.24
    patch:
      description: Update a Batch Prediction job definition
      operationId: batchPredictionJobDefinitions_patch
      parameters:
      - description: ID of the Batch Prediction job definition
        in: path
        name: jobDefinitionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobDefinitionsUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobDefinitionsResponse'
          description: Job details for the updated Batch Prediction job definition
        '403':
          description: You are not authorized to alter the contents of this job definition
            due to your permissions role
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
        '409':
          description: You chose a name of your job definition that was already existing
            within your organization
      summary: Update Batch Prediction job definition
      tags:
      - predictions
      x-versionadded: v2.24
  /api/v2/batchPredictionJobDefinitions/{jobDefinitionId}/portable/:
    get:
      description: Retrieve a Batch Prediction job definition for Portable Batch Predictions
      operationId: batchPredictionJobDefinitionsPortable_list
      parameters:
      - description: ID of the Batch Prediction job definition
        in: path
        name: jobDefinitionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Snippet for Portable Batch Predictions
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
      summary: Retrieve job definition snippet for PBP
      tags:
      - predictions
      x-versionadded: v2.26
  /api/v2/batchPredictions/:
    get:
      description: Get a collection of batch prediction jobs by statuses
      operationId: batchPredictions_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.21
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 10000
          minimum: 1
          type: integer
        x-versionadded: v2.21
      - description: Includes only jobs that have the status value that matches this
          flag. Repeat the parameter for filtering on multiple statuses.
        in: query
        name: status
        required: false
        schema:
          oneOf:
          - enum:
            - INITIALIZING
            - RUNNING
            - COMPLETED
            - ABORTED
            - FAILED
            type: string
          - items:
              enum:
              - INITIALIZING
              - RUNNING
              - COMPLETED
              - ABORTED
              - FAILED
              type: string
            type: array
      - description: Includes only jobs that have the source value that matches this
          flag. Repeat the parameter for filtering on multiple statuses.Prefix values
          with a dash (`-`) to exclude those sources.
        in: query
        name: source
        required: false
        schema:
          oneOf:
          - enum:
            - other
            - api_client_r
            - api_client_python
            - integration_snippet_requests
            - integration_snippet_api_client
            - integration_snippet_standalone_python
            - integration_snippet_standalone_powershell
            - ui_make_prediction
            - ui_leaderboard_make_prediction
            - ui_uxr_make_prediction
            - integration_job
            - scheduled_from_job_definition
            - manual_run_from_job_definition
            - model_package_insights
            - portable_batch_predictions
            - data_pipelines
            - challenger_replay
            - -other
            - -api_client_r
            - -api_client_python
            - -integration_snippet_requests
            - -integration_snippet_api_client
            - -integration_snippet_standalone_python
            - -integration_snippet_standalone_powershell
            - -ui_make_prediction
            - -ui_leaderboard_make_prediction
            - -ui_uxr_make_prediction
            - -integration_job
            - -scheduled_from_job_definition
            - -manual_run_from_job_definition
            - -model_package_insights
            - -portable_batch_predictions
            - -data_pipelines
            - -challenger_replay
            type: string
          - items:
              enum:
              - other
              - api_client_r
              - api_client_python
              - integration_snippet_requests
              - integration_snippet_api_client
              - integration_snippet_standalone_python
              - integration_snippet_standalone_powershell
              - ui_make_prediction
              - ui_leaderboard_make_prediction
              - ui_uxr_make_prediction
              - integration_job
              - scheduled_from_job_definition
              - manual_run_from_job_definition
              - model_package_insights
              - portable_batch_predictions
              - data_pipelines
              - challenger_replay
              - -other
              - -api_client_r
              - -api_client_python
              - -integration_snippet_requests
              - -integration_snippet_api_client
              - -integration_snippet_standalone_python
              - -integration_snippet_standalone_powershell
              - -ui_make_prediction
              - -ui_leaderboard_make_prediction
              - -ui_uxr_make_prediction
              - -integration_job
              - -scheduled_from_job_definition
              - -manual_run_from_job_definition
              - -model_package_insights
              - -portable_batch_predictions
              - -data_pipelines
              - -challenger_replay
              type: string
            type: array
      - description: Includes only jobs for this particular deployment
        in: query
        name: deploymentId
        required: false
        schema:
          type: string
        x-versionadded: v2.21
      - description: ID of leaderboard model which is used in job for processing predictions
          dataset
        in: query
        name: modelId
        required: false
        schema:
          type: string
        x-versionadded: v2.29
      - description: Includes only job by specific id
        in: query
        name: jobId
        required: false
        schema:
          type: string
        x-versionadded: v2.28
      - description: Sort order which will be applied to batch prediction list. Prefix
          the attribute name with a dash to sort in descending order, e.g. "-created".
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - created
          - -created
          - status
          - -status
          type: string
        x-versionadded: v2.22
      - description: '[DEPRECATED - replaced with RBAC permission model] - No effect'
        in: query
        name: allJobs
        required: false
        schema:
          default: false
          type: boolean
        x-versionadded: v2.23
        x-versiondeprecated: v2.32
      - description: Only list jobs created at most this amount of hours ago.
        in: query
        name: cutoffHours
        required: false
        schema:
          maximum: 8760
          minimum: 0
          type: integer
        x-versionadded: v2.24
      - description: ISO-formatted datetime of the earliest time the job was added
          (inclusive). For example "2008-08-24T12:00:00Z". Will ignore cutoffHours
          if set.
        in: query
        name: startDateTime
        required: false
        schema:
          format: date-time
          type: string
      - description: ISO-formatted datetime of the latest time the job was added (inclusive).
          For example "2008-08-24T12:00:00Z".
        in: query
        name: endDateTime
        required: false
        schema:
          format: date-time
          type: string
      - description: Includes only jobs for this particular definition
        in: query
        name: batchPredictionJobDefinitionId
        required: false
        schema:
          type: string
        x-versionadded: v2.24
      - description: Includes only jobs for this particular prediction instance hostname
        in: query
        name: hostname
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        x-versionadded: v2.24
      - description: Includes only jobs for these particular intakes type
        in: query
        name: intakeType
        required: false
        schema:
          oneOf:
          - enum:
            - local_file
            - azure
            - bigquery
            - dataStage
            - dataset
            - dss
            - gcp
            - http
            - jdbc
            - localFile
            - recipe
            - s3
            - snowflake
            - synapse
            type: string
          - items:
              enum:
              - local_file
              - azure
              - bigquery
              - dataStage
              - dataset
              - dss
              - gcp
              - http
              - jdbc
              - localFile
              - recipe
              - s3
              - snowflake
              - synapse
              type: string
            type: array
        x-versionadded: v2.21
      - description: Includes only jobs for these particular outputs type
        in: query
        name: outputType
        required: false
        schema:
          oneOf:
          - enum:
            - local_file
            - azure
            - bigquery
            - gcp
            - http
            - jdbc
            - localFile
            - s3
            - snowflake
            - synapse
            - tableau
            type: string
          - items:
              enum:
              - local_file
              - azure
              - bigquery
              - gcp
              - http
              - jdbc
              - localFile
              - s3
              - snowflake
              - synapse
              - tableau
              type: string
            type: array
        x-versionadded: v2.21
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobListResponse'
          description: A list of Batch Prediction job objects
      summary: List batch prediction jobs
      tags:
      - predictions
      x-versionadded: v2.19
    post:
      description: Submit the configuration for the job and it will be submitted to
        the queue
      operationId: batchPredictions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobResponse'
          description: Job details for the created Batch Prediction job
      summary: Creates a new Batch Prediction job
      tags:
      - predictions
      x-versionadded: v2.19
  /api/v2/batchPredictions/fromExisting/:
    post:
      description: Copies an existing job and submits it to the queue.
      operationId: batchPredictionsFromExisting_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobId'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobResponse'
          description: Job details for the created Batch Prediction job
      summary: Create a new a Batch Prediction job based on an existing Batch Prediction
        job.
      tags:
      - predictions
      x-versionadded: v2.21
  /api/v2/batchPredictions/fromJobDefinition/:
    post:
      description: Launches a one-time batch prediction job based off of the previously
        supplied definition referring to the job definition ID and puts it on the
        queue.
      operationId: batchPredictionsFromJobDefinition_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobDefinitionId'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobResponse'
          description: Job details for the created Batch Prediction job
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
      summary: Launch a Batch Prediction job for scoring
      tags:
      - predictions
      x-versionadded: v2.24
  /api/v2/batchPredictions/{predictionJobId}/:
    delete:
      description: If the job is running, it will be aborted. Then it will be removed,
        meaning all underlying data will be deleted and the job is removed from the
        list of jobs.
      operationId: batchPredictions_delete
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      responses:
        '202':
          description: Job cancelled
        '404':
          description: Job does not exist or was not submitted to the queue.
        '409':
          description: 'Job cannot be aborted for some reason. Possible reasons: job
            is already aborted or completed.'
      summary: Cancel a Batch Prediction job
      tags:
      - predictions
      x-versionadded: v2.19
    get:
      description: Retrieve a Batch Prediction job.
      operationId: batchPredictions_retrieve
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobResponse'
          description: Job details for the requested Batch Prediction job
      summary: Retrieve Batch Prediction job
      tags:
      - predictions
      x-versionadded: v2.19
    patch:
      description: 'If a job has finished execution regardless of the result, it can
        have parameters changed to ensure better filtering in the job list upon retrieval.
        Another case: updating job scoring status externally.'
      operationId: batchPredictions_patch
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPredictionJobResponse'
          description: Job updated
        '404':
          description: Job does not exist or was not submitted to the queue.
        '409':
          description: 'Job cannot be hidden for some reason. Possible reasons: job
            is not in a deletable state.'
      summary: Update a Batch Prediction job
      tags:
      - predictions
      x-versionadded: v2.24
  /api/v2/batchPredictions/{predictionJobId}/csvUpload/:
    put:
      description: Stream CSV data to the prediction job. Only available for jobs
        thatuses the localFile intake option.
      operationId: batchPredictionsCsvUpload_putMany
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      responses:
        '202':
          description: Job data was successfully submitted
        '404':
          description: Job does not exist or does not require data
        '406':
          description: Not acceptable MIME type
        '409':
          description: Dataset upload has already begun
        '422':
          description: Job was "ABORTED" due to too many errors in the data
      summary: Creates a new_model_id Batch Prediction job
      tags:
      - predictions
      x-versionadded: v2.19
  /api/v2/batchPredictions/{predictionJobId}/csvUpload/finalizeMultipart/:
    post:
      description: Finalize a multipart upload, indicating that no further chunks
        will be sent
      operationId: batchPredictionsCsvUploadFinalizeMultipart_create
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      responses:
        '202':
          description: Acknowledgement that the request was accepted or an error message
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
        '409':
          description: Only multipart jobs can be finalized.
        '422':
          description: No data was uploaded
      summary: Finalize a multipart upload
      tags:
      - predictions
      x-versionadded: v2.28
  /api/v2/batchPredictions/{predictionJobId}/csvUpload/part/{partNumber}/:
    put:
      description: Stream CSV data to the prediction job in many parts.Only available
        for jobs that uses the localFile intake option.
      operationId: batchPredictionsCsvUploadPart_put
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      responses:
        '202':
          description: Job data was successfully submitted
        '404':
          description: Job does not exist or does not require data
        '406':
          description: Not acceptable MIME type
        '409':
          description: Dataset upload has already begun
        '422':
          description: Job was "ABORTED" due to too many errors in the data
      summary: Upload CSV data in multiple parts
      tags:
      - predictions
      x-versionadded: v2.28
  /api/v2/batchPredictions/{predictionJobId}/download/:
    get:
      description: This is only valid for jobs scored using the "localFile" output
        option
      operationId: batchPredictionsDownload_list
      parameters:
      - description: ID of the Batch Prediction job
        in: path
        name: predictionJobId
        required: true
        schema:
          type: string
      - description: 'The number of which csv part is being uploaded when using multipart
          upload '
        in: path
        name: partNumber
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
        x-versionadded: v2.27
      responses:
        '200':
          description: Job was downloaded correctly
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=result-<id>.csv").
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - text/csv
                type: string
        '404':
          description: Job does not exist or is not completed
        '406':
          description: Not acceptable MIME type
        '422':
          description: Job was "ABORTED" due to too many errors in the data
      summary: Download the scored data set of a batch prediction job
      tags:
      - predictions
      x-versionadded: v2.19
  /api/v2/bulkUserOperations/:
    post:
      description: Make multiple User creation requests in bulk from a list.
      operationId: bulkUserOperations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBulkCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBulkCreateResponse'
          description: List of responses from each User creation request.
        '422':
          description: Invalid request payload.
      summary: Make multiple User creation requests in bulk from a list.
      tags:
      - user_management
      x-versionadded: v2.29
  /api/v2/calendarCountryCodes/:
    get:
      description: Retrieve the list of allowed country codes to request preloaded
        calendars generation for.
      operationId: calendarCountryCodes_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreloadedCalendarListResponse'
          description: Request for the list of allowed country codes that have the
            generated preloaded calendars.
      summary: Retrieve the list of allowed country codes to request preloaded calendars
        generation for.
      tags:
      - projects
      x-versionadded: v2.23
  /api/v2/calendars/:
    get:
      description: List all the calendars which the user has access to.
      operationId: calendars_list
      parameters:
      - description: Optional, if provided will filter returned calendars to those
          being used in the specified project.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: 'Optional (default: `0`), this many results will be skipped.'
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: 'Optional (default: `0`), at most this many results will be returned.
          If `0`, all results will be returned.'
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarListResponse'
          description: A list of Calendar objects.
      summary: List all available calendars for a user.
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/calendars/fileUpload/:
    post:
      description: Create a calendar from a file in a csv or xlsx format. The calendar
        file specifies the dates or events in a dataset such that DataRobot automatically
        derives and creates special features based on the calendar events (e.g., time
        until the next event, labeling the most recent event).
      operationId: calendarsFileUpload_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarFileUpload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
          description: Request for calendar generation was submitted. See Location
            header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create a calendar from a file.
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/calendars/fromCountryCode/:
    post:
      description: Initialize generation of preloaded calendars. Preloaded calendars
        are available only for time series projects. Preloaded calendars do not support
        multiseries calendars.
      operationId: calendarsFromCountryCode_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreloadedCalendar'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
          description: Request for calendar generation was submitted. See Location
            header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Initialize generation of preloaded calendars.
      tags:
      - projects
      x-versionadded: v2.23
  /api/v2/calendars/fromDataset/:
    post:
      description: Create a calendar from the dataset.
      operationId: calendarsFromDataset_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarFromDataset'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedCalendarDatasetResponse'
          description: Successfully created a calendar from the dataset.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create a calendar from the dataset
      tags:
      - projects
      x-versionadded: v2.21
  /api/v2/calendars/{calendarId}/:
    delete:
      description: Delete a calendar. This can only be done if all projects and deployments
        using the calendar have been deleted.
      operationId: calendars_delete
      parameters:
      - description: The ID of this calendar.
        in: path
        name: calendarId
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
          description: Calendar successfully deleted.
        '404':
          description: Invalid `calendarId` provided, or user does not have permissions
            to delete calendar.
      summary: Delete a calendar.
      tags:
      - projects
      x-versionadded: v2.15
    get:
      description: List all the information about a calendar such as the total number
        of event dates, the earliest calendar event date, the IDs of projects currently
        using this calendar and the others.
      operationId: calendars_retrieve
      parameters:
      - description: The ID of this calendar.
        in: path
        name: calendarId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarRecord'
          description: Request for a Calendar object was successful.
      summary: Retrieve information about a calendar.
      tags:
      - projects
      x-versionadded: v2.15
    patch:
      description: Update a calendar's name
      operationId: calendars_patch
      parameters:
      - description: The ID of this calendar.
        in: path
        name: calendarId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarNameUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
          description: Calendar name successfully updated.
        '404':
          description: Invalid `calendarId` provided, or user does not have permissions
            to update calendar.
      summary: Update a calendar's name
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/calendars/{calendarId}/accessControl/:
    get:
      description: Get a list of users who have access to this calendar and their
        roles on the calendar.
      operationId: calendarsAccessControl_list
      parameters:
      - description: Optional, only return the access control information for a user
          with this username. Should not be specified if `userId` is specified.
        in: query
        name: username
        required: false
        schema:
          type: string
      - description: Optional, only return the access control information for a user
          with this user ID. Should not be specified if `username` is specified.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: 'Optional (default: `0`), this many results will be skipped.'
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: 'Optional (default: `0`), at most this many results will be returned.
          If `0`, all results will be returned.'
        in: query
        name: limit
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of this calendar.
        in: path
        name: calendarId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarAccessControlListResponse'
          description: Request for the list of users who have access to this calendar
            and their roles on the calendar was successful.
        '400':
          description: Both `username` and `userId` were specified.
        '404':
          description: Entity not found. Either the calendar does not exist or the
            user does not have permissions to view the calendar.
      summary: Get a list of users who have access to this calendar and their roles
        on the calendar.
      tags:
      - projects
      x-versionadded: v2.15
    patch:
      description: Update the access control for this calendar. See the `entity sharing
        documentation <sharing>` for more information.
      operationId: calendarsAccessControl_patchMany
      parameters:
      - description: The ID of this calendar.
        in: path
        name: calendarId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarAccessControlUpdate'
      responses:
        '200':
          description: Request to update the accesss control for this calendar was
            sussessful.
        '404':
          description: Invalid `calendarId` provided, or user has no access whatsoever
            on the specified calendar.
        '422':
          description: Invalid `username` provided to modify access for the specified
            calendar.
      summary: Update the access control for this calendar.
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/catalogItems/:
    get:
      description: List all catalog items accessible by the user.
      operationId: catalogItems_list
      parameters:
      - description: Specifies the number of results to skip for pagination.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Sets the maximum number of results returned. Enter 0 to specify
          no limit.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The initial cache size, for Mongo search only.
        in: query
        name: initialCacheSize
        required: true
        schema:
          default: 500
          maximum: 10000
          minimum: 1
          type: integer
      - description: Sets whether to use the cache, for Mongo search only.
        in: query
        name: useCache
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: 'The attribute sort order applied to the returned catalog list:
          ''catalogName'', ''originalName'', ''description'', ''created'', or ''relevance''.
          For all options other than ''relevance'', prefix the attribute name with
          a dash to sort in descending order. e.g., orderBy=''-catalogName''. Defaults
          to ''-created''.'
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - originalName
          - -originalName
          - catalogName
          - -catalogName
          - description
          - -description
          - created
          - -created
          - relevance
          - -relevance
          type: string
      - description: A value to search for in the dataset's name, description, tags,
          column names, categories, and latest errors. The search is case insensitive.
          If no value is provided, or if the empty string is used, or if the string
          contains only whitespace, no filtering occurs. Partial matching is performed
          on the dataset name and description fields; all other fields require an
          exact match.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: Filter results to display only items with the specified catalog
          item tags, in lower case, with no spaces.
        in: query
        name: tag
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: 'Access type used to filter returned results. Valid options are
          ''owner'', ''shared'', ''created'', and ''any'' (the default): ''owner''
          items are owned by the requester, ''shared'' items have been shared with
          the requester, ''created'' items have been created by the requester, and
          ''any'' items matches all.'
        in: query
        name: accessType
        required: false
        schema:
          default: any
          enum:
          - owner
          - shared
          - any
          - created
          type: string
      - description: Data source types used for filtering.
        in: query
        name: datasourceType
        required: false
        schema:
          oneOf:
          - enum:
            - local
            - url
            - hdfs
            - jdbc
            - spark
            - dr-database-v1
            type: string
          - items:
              enum:
              - local
              - url
              - hdfs
              - jdbc
              - spark
              - dr-database-v1
              type: string
            type: array
      - description: Category type(s) used for filtering. Searches are case sensitive
          and support '&' and 'OR' operators.
        in: query
        name: category
        required: false
        schema:
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - PREDICTION
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - PREDICTION
              - TRAINING
              type: string
            type: array
        x-versionadded: v2.21
      - description: Sets whether to exclude from the search results all catalog items
          that failed during import. If True, invalid catalog items will be excluded;
          default is False.
        in: query
        name: filterFailed
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter results to display only those owned by user(s) identified
          by the specified UID.
        in: query
        name: ownerUserId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Filter results to display only those owned by user(s) identified
          by the specified username.
        in: query
        name: ownerUsername
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Filter results by catalog type. The 'dataset' option matches
          both 'snapshot_dataset' and 'remote_dataset'.
        in: query
        name: type
        required: false
        schema:
          enum:
          - dataset
          - snapshot_dataset
          - remote_dataset
          - user_blueprint
          type: string
        x-enum-versionadded:
        - value: user_blueprint
          x-versionadded: v2.25
        x-versionadded: v2.22
      - description: Filter results by catalogType = 'snapshot_dataset' and catalogType
          = 'remote_dataset' and data_origin in ['snowflake', 'bigquery-v1']
        in: query
        name: isUxrPreviewable
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogListSearchResponse'
          description: Paginated list of catalog items is returned.
      summary: List all catalog items accessible by the user.
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/catalogItems/{catalogId}/:
    get:
      description: Retrieves latest version information, by ID, for catalog items.
      operationId: catalogItems_retrieve
      parameters:
      - description: Catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogDetailsRetrieveResponse'
          description: Catalog item details retrieved successfully.
      summary: Retrieves latest version information, by ID, for catalog items.
      tags:
      - ai_catalog
      x-versionadded: v2.18
    patch:
      description: Update the name, description, or tags for the requested catalog
        item.
      operationId: catalogItems_patch
      parameters:
      - description: Catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCatalogMetadata'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogExtendedDetailsResponse'
          description: Extended details of the updated catalog item.
        '403':
          description: User does not have permission to update this catalog item.
        '410':
          description: Requested catalog item was previously deleted.
      summary: Update the name, description, or tags for the requested catalog item.
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/changeRequests/:
    get:
      description: List all Change Requests accessible by the user for the given product
        entity type.
      operationId: changeRequests_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Type of the entity to filter requests by.
        in: query
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      - description: ID of the entity to filter change requests by.
        in: query
        name: entityId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Filter change requests by the owner. If `true`, only returns
          change requests owned by the user. If `false`, only returns change requests
          owned by other users but accessible to the requester.
        in: query
        name: myRequests
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter change requests by status. If `true`, only returns approved
          change requests. If `false`, only returns not approved change requests.
        in: query
        name: showApproved
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter change requests by status. If `true`, only returns cancelled
          change requests. If `false`, only returns not cancelled change requests.
        in: query
        name: showCancelled
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter change requests by status.
        in: query
        name: status
        required: false
        schema:
          oneOf:
          - enum:
            - pending
            - Pending
            - PENDING
            - approved
            - Approved
            - APPROVED
            - changesRequested
            - ChangesRequested
            - CHANGES_REQUESTED
            - resolved
            - Resolved
            - RESOLVED
            - cancelled
            - Cancelled
            - CANCELLED
            type: string
          - items:
              enum:
              - pending
              - Pending
              - PENDING
              - approved
              - Approved
              - APPROVED
              - changesRequested
              - ChangesRequested
              - CHANGES_REQUESTED
              - resolved
              - Resolved
              - RESOLVED
              - cancelled
              - Cancelled
              - CANCELLED
              type: string
            type: array
      - description: The order that the results should be retrieved in.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - createdAt
          - -createdAt
          - processedAt
          - -processedAt
          - updatedAt
          - -updatedAt
          type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRequestsListResponse'
          description: ''
      summary: List Change Requests.
      tags:
      - governance
      x-versionadded: v2.28
    post:
      description: Request changes for a supported product entity. For now, you can
        request changes for deployments only.
      operationId: changeRequests_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRequestCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRequestResponse'
          description: Change Request Created.
      summary: Create Change Request.
      tags:
      - governance
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/:
    get:
      description: Retrieve Change Request by ID.
      operationId: changeRequests_retrieve
      parameters:
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRequestResponse'
          description: ''
      summary: Retrieve Change Request.
      tags:
      - governance
      x-versionadded: v2.28
    patch:
      description: Update Change Request with the given ID.
      operationId: changeRequests_patch
      parameters:
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRequestUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRequestResponse'
          description: ''
      summary: Update Change Request.
      tags:
      - governance
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/reviews/:
    get:
      description: List Change Request reviews.
      operationId: changeRequestsReviews_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Review status to filter by.
        in: query
        name: status
        required: false
        schema:
          enum:
          - approved
          - Approved
          - APPROVED
          - changesRequested
          - ChangesRequested
          - CHANGES_REQUESTED
          - commented
          - Commented
          - COMMENTED
          type: string
      - description: ID of the change version to filter by
        in: query
        name: changeVersionId
        required: false
        schema:
          type: string
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewsListResponse'
          description: ''
      summary: List Change Request reviews.
      tags:
      - governance
      x-versionadded: v2.28
    post:
      description: Review the Change Request.
      operationId: changeRequestsReviews_create
      parameters:
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewResponse'
          description: ''
      summary: Create review.
      tags:
      - governance
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/reviews/{reviewId}/:
    get:
      description: Retrieve a review by ID.
      operationId: changeRequestsReviews_retrieve
      parameters:
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      - description: ID of the review.
        in: path
        name: reviewId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewResponse'
          description: ''
      summary: Retrieve review.
      tags:
      - governance
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/status/:
    patch:
      description: Resolve or Cancel the Change Request.
      operationId: changeRequestsStatus_patchMany
      parameters:
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRequestUpdateStatus'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeRequestUpdateStatus'
          description: ''
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Resolve or Cancel the Change Request.
      tags:
      - governance
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/suggestedReviewers/:
    get:
      description: List users, suggested to review the Change Request.
      operationId: changeRequestsSuggestedReviewers_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: ID of the Change Request.
        in: path
        name: changeRequestId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestedReviewersResponse'
          description: ''
      summary: List suggested reviewers.
      tags:
      - governance
      x-versionadded: v2.28
  /api/v2/clusterLicense/:
    get:
      description: Retrieve the information about the currently deployed cluster license.
      operationId: clusterLicense_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterLicenseRetrieveResponse'
          description: ''
      summary: Retrieve the information about cluster license
      tags:
      - infrastructure
      x-versionadded: v2.23
    put:
      description: Create or replace the cluster license.
      operationId: clusterLicense_putMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterLicenseUpdate'
      responses:
        '200':
          description: ''
        '422':
          description: License is invalid or has expired.
      summary: Create or replace license
      tags:
      - infrastructure
      x-versionadded: v2.23
  /api/v2/clusterLicenseValidation/:
    post:
      description: Check if a cluster license is valid.
      operationId: clusterLicenseValidation_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterLicenseUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterLicenseValidationResponse'
          description: ''
        '422':
          description: License is invalid or has expired.
      summary: Check if a license is valid
      tags:
      - infrastructure
      x-versionadded: v2.23
  /api/v2/comments/:
    post:
      description: Post a comment
      operationId: comments_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Comment'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentRetrieve'
          description: ''
        '201':
          description: The comment was successfully created
        '422':
          description: The request was formatted improperly
      summary: Post a comment
      tags:
      - comments
      x-versionadded: v2.21
  /api/v2/comments/{commentId}/:
    delete:
      description: Delete a comment
      operationId: comments_delete
      parameters:
      - description: The ID of the comment
        in: path
        name: commentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '204':
          description: The use case comment was deleted
      summary: Delete a comment
      tags:
      - comments
      x-versionadded: v2.21
    get:
      description: Retrieve a comment
      operationId: comments_retrieve
      parameters:
      - description: The ID of the comment
        in: path
        name: commentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentRetrieve'
          description: ''
      summary: Retrieve a comment
      tags:
      - comments
      x-versionadded: v2.21
    patch:
      description: Update a comment
      operationId: comments_patch
      parameters:
      - description: The ID of the comment
        in: path
        name: commentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentUpdate'
      responses:
        '200':
          description: ''
        '204':
          description: The comment was successfully updated
        '422':
          description: The request was formatted improperly
      summary: Update a comment
      tags:
      - comments
      x-versionadded: v2.21
  /api/v2/comments/{entityType}/{entityId}/:
    get:
      description: List comments
      operationId: comments_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Sort comments by a field of the comment.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - createdAt
          - -createdAt
          - updatedAt
          - -updatedAt
          type: string
      - description: ID of the entity to retrieve comments of
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Type of the entity to retrieve a comments of, currently only
          useCase is supported
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - useCase
          - model
          - catalog
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentList'
          description: ''
      summary: List comments
      tags:
      - comments
      x-versionadded: v2.24
  /api/v2/complianceDocTemplates/:
    get:
      description: List user's custom-built compliance documentation templates.
      operationId: complianceDocTemplates_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: When present, only return templates with names that contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          default: ''
          type: string
      - description: Sort order to apply to the dataset list. Prefix the attribute
          name with a dash to sort in descending order (e.g., orderBy='-id').
        in: query
        name: orderBy
        required: false
        schema:
          default: id
          enum:
          - id
          - -id
          type: string
      - description: Name of labels to filter by.
        in: query
        name: labels
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.22
      - description: Type of project templates to search for. If not specified, returns
          all project templates types.
        in: query
        name: projectType
        required: false
        schema:
          enum:
          - autoMl
          - timeSeries
          nullable: true
          type: string
        x-versionadded: v2.22
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceDocTemplateListResponse'
          description: Successfully returned list of templates
      summary: List compliance documentation templates
      tags:
      - documentation
      x-versionadded: v2.14
    post:
      description: Create a new compliance documentation template. One can retrieve
        the default DataRobot template via ``GET /api/v2/complianceDocTemplates/default/``
        endpoint.
      operationId: complianceDocTemplates_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceDocTemplateCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceDocTemplateCreateResponse'
          description: Model compliance documentation template created successfully
          headers:
            Location:
              description: URL location of the newly created template.
              schema:
                format: url
                type: string
        '422':
          description: Template cannot be created, e.g., invalid sections or name
            already exists
      summary: Create a new compliance documentation template
      tags:
      - documentation
      x-versionadded: v2.14
  /api/v2/complianceDocTemplates/default/:
    get:
      description: Retrieve the default documentation template.
      operationId: complianceDocTemplatesDefault_list
      parameters:
      - description: Specifies the type of the default template to retrieve, either
          ``normal`` or ``timeSeries``. The ``normal`` template is applicable for
          all AutoML projects that are not time series. The ``timeSeries`` template
          is only applicable to time series projects.
        in: query
        name: type
        required: true
        schema:
          default: normal
          enum:
          - normal
          - timeSeries
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceDocTemplateDefaultRetrieveResponse'
          description: Successfully retrieved default template
      summary: Retrieve the default documentation template
      tags:
      - documentation
      x-versionadded: v2.14
  /api/v2/complianceDocTemplates/{templateId}/:
    delete:
      description: 'Delete a compliance documentation template.

        Documentation previously generated using this template will remain unchanged.'
      operationId: complianceDocTemplates_delete
      parameters:
      - description: The Id of a model compliance document template accessible by
          the user
        in: path
        name: templateId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Template deleted successfully
        '403':
          description: Insufficient permissions to delete template
        '404':
          description: Template not found
      summary: Delete a compliance documentation template
      tags:
      - documentation
      x-versionadded: v2.14
    get:
      description: Retrieve a JSON representation of a custom Compliance Documentation
        template.
      operationId: complianceDocTemplates_retrieve
      parameters:
      - description: The Id of a model compliance document template accessible by
          the user
        in: path
        name: templateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateResponse'
          description: Successfully retrieved template
        '404':
          description: No matching template owned by this user was found
      summary: Retrieve a documentation template
      tags:
      - documentation
      x-versionadded: v2.14
    patch:
      description: 'Update an existing model compliance documentation template with
        the given ``templateId``. The template must be accessible by the user. If
        the ``templateId`` is not found for the user, the update cannot be performed.

        For a description of the template ``sections`` object options, see the sample
        ``sections`` on the schema below.'
      operationId: complianceDocTemplates_patch
      parameters:
      - description: The Id of a model compliance document template accessible by
          the user
        in: path
        name: templateId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceDocTemplateUpdate'
      responses:
        '204':
          description: Model compliance documentation template updated successfully
        '403':
          description: Not enough permissions to edit template
        '404':
          description: Template not found
      summary: Update an existing model compliance documentation template
      tags:
      - documentation
      x-versionadded: v2.14
  /api/v2/complianceDocTemplates/{templateId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this template and their roles on the template.
      operationId: complianceDocTemplatesSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The template identifier
        in: path
        name: templateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The template's access control list.
        '404':
          description: Either the template does not exist or the user does not have
            permissions to view the template.
        '422':
          description: Both username and userId were specified
      summary: Get template's access control list
      tags:
      - documentation
      x-versionadded: v2.21
    patch:
      description: Set roles for users on this template.
      operationId: complianceDocTemplatesSharedRoles_patchMany
      parameters:
      - description: The template identifier
        in: path
        name: templateId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the template without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update template's access controls
      tags:
      - documentation
      x-versionadded: v2.22
  /api/v2/credentials/:
    get:
      description: List all sets of credentials available for given user.
      operationId: credentials_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Includes only credentials of the specified type. Repeat the parameter
          for filtering on multiple statuses.
        in: query
        name: types
        required: false
        schema:
          oneOf:
          - enum:
            - adls_gen2_oauth
            - api_token
            - azure
            - azure_service_principal
            - basic
            - bearer
            - databricks_access_token_account
            - databricks_service_principal_account
            - gcp
            - oauth
            - rsa
            - s3
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_service_principal
              - basic
              - bearer
              - databricks_access_token_account
              - databricks_service_principal_account
              - gcp
              - oauth
              - rsa
              - s3
              - snowflake_key_pair_user_account
              - snowflake_oauth_user_account
              - tableau_access_token
              type: string
            type: array
      - description: The order to sort the credentials. Defaults to the order by the
          creation_date in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - creationDate
          - -creationDate
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsListResponse'
          description: A paginated list of credentials.
      summary: List credentials.
      tags:
      - credentials
      x-versionadded: v2.19
    post:
      description: Store a new set of credentials.
      operationId: credentials_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsBody'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCredentialsResponse'
          description: Credentials stored successfully.
        '409':
          description: The specified name is already in use.
      summary: Store a new set of credentials which can be used for data sources creation.
      tags:
      - credentials
      x-versionadded: v2.19
  /api/v2/credentials/associations/{associationId}/:
    get:
      description: Returns a list of credentials associated with the specified object
        for the given session user.
      operationId: credentialsAssociations_listForObject
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Sort order which will be applied to credential associations list.
          Prefix the attribute name with a dash to sort in descending order, e.g.
          "-is_default".  Absent by default.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - isDefault
          - -isDefault
          type: string
      - description: 'The compound ID of the data connection. <association_id> ==
          <object_type>:<object_id> Where: <object_id> of ObjectId type - the ID of
          the data connection; <object_type> of string type - the type of data connection
          from CredentialMappingResourceTypes Enum: dataconnection, batch_prediction_job_definition.'
        in: path
        name: associationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCredentialsAssociationsResponse'
          description: List of credentials associated with the object for the session
            user.
      summary: List credentials associated with the specified object.
      tags:
      - credentials
      x-versionadded: v2.30
  /api/v2/credentials/{credentialId}/:
    delete:
      description: Delete the credential set matching the specified ID if it is not
        used by any data connection or batch prediction job.
      operationId: credentials_delete
      parameters:
      - description: Credentials entity ID.
        in: path
        name: credentialId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Credentials deleted successfully.
        '409':
          description: Credentials are in use by one or more data connections or batch
            prediction jobs.
      summary: Delete the credentials set.
      tags:
      - credentials
      x-versionadded: v2.19
    get:
      description: Return the credential set matching the specified ID.
      operationId: credentials_retrieve
      parameters:
      - description: Credentials entity ID.
        in: path
        name: credentialId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCredentialsResponse'
          description: Credentials retrieved successfully.
      summary: Retrieve the credentials set.
      tags:
      - credentials
      x-versionadded: v2.19
    patch:
      description: Update specified credentials
      operationId: credentials_patch
      parameters:
      - description: Credentials entity ID.
        in: path
        name: credentialId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsUpdate'
      responses:
        '200':
          description: Set of credentials updated
        '404':
          description: Requested credentials not found
        '409':
          description: The name specified for credentials is already in use.
        '422':
          description: Must specify at least one field to update
      summary: Update specified credentials
      tags:
      - credentials
      x-versionadded: v2.19
  /api/v2/credentials/{credentialId}/associations/:
    get:
      description: List all objects associated with specified credentials for the
        current user.
      operationId: credentialsAssociations_listForCredential
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Includes only credentials of the specified type. Repeat the parameter
          for filtering on multiple statuses.
        in: query
        name: types
        required: false
        schema:
          oneOf:
          - enum:
            - adls_gen2_oauth
            - api_token
            - azure
            - azure_service_principal
            - basic
            - bearer
            - databricks_access_token_account
            - databricks_service_principal_account
            - gcp
            - oauth
            - rsa
            - s3
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_service_principal
              - basic
              - bearer
              - databricks_access_token_account
              - databricks_service_principal_account
              - gcp
              - oauth
              - rsa
              - s3
              - snowflake_key_pair_user_account
              - snowflake_oauth_user_account
              - tableau_access_token
              type: string
            type: array
      - description: The order to sort the credentials. Defaults to the order by the
          creation_date in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - creationDate
          - -creationDate
          type: string
      - description: Credentials entity ID.
        in: path
        name: credentialId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsListAssociationsResponse'
          description: Objects associated with the specified credentials for the current
            user.
      summary: List all objects associated with the specified credentials.
      tags:
      - credentials
      x-versionadded: v2.19
    patch:
      description: Add objects associated with credentials
      operationId: credentialsAssociations_patchMany
      parameters:
      - description: Credentials entity ID.
        in: path
        name: credentialId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsAssociationUpdate'
      responses:
        '200':
          description: ''
        '204':
          description: Credentials association updated
        '404':
          description: Requested credentials not found
        '409':
          description: One or more associations already exists when adding or one
            or more associations do not exist
        '422':
          description: Must specify a field to update or must specify only one of
            `credentialsToAdd` or `credentialsToRemove`.
      summary: Add objects associated with credentials
      tags:
      - credentials
      x-versionadded: v2.19
  /api/v2/credentials/{credentialId}/associations/{associationId}/:
    put:
      description: Set (create or update) the credentials' association for the given
        Data Connection for the given session Owner for the given credentials.
      operationId: credentialsAssociations_put
      parameters:
      - description: Credentials entity ID.
        in: path
        name: credentialId
        required: true
        schema:
          type: string
      - description: 'The compound ID of the data connection. <association_id> ==
          <object_type>:<object_id> Where: <object_id> of ObjectId type - the ID of
          the data connection; <object_type> of string type - the type of data connection
          from CredentialMappingResourceTypes Enum: dataconnection, batch_prediction_job_definition.'
        in: path
        name: associationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetCredentialsAssociationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCredentialAssociationResponse'
          description: Credentials association was successfully set (created or updated).
        '201':
          description: New credential association was created.
      summary: Set default credentials.
      tags:
      - credentials
      x-versionadded: v2.30
  /api/v2/customInferenceImages/{imageId}/featureImpact/:
    get:
      description: "Retrieve feature impact scores for features in a custom inference\
        \ model image.\n\n.. minversion:: v2.23\n    DEPRECATED: please use version\
        \ route instead:\n    :http:get:`/api/v2/customModels/(customModelId)/versions/(customModelVersionId)/featureImpact/`\n\
        \nThis route is a counterpart of a corresponding endpoint for native models:\n\
        :http:get:`/api/v2/projects/(projectId)/models/(modelId)/featureImpact/`\n"
      operationId: customInferenceImagesFeatureImpact_list
      parameters:
      - description: ID of the image of the custom inference model to retrieve feature
          impact from.
        in: path
        name: imageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureImpactResponse'
          description: Custom model feature impact returned.
        '404':
          description: No feature impact data found for custom model.
        '422':
          description: 'Cannot retrieve feature impact scores: (1) if custom model
            is not an inference model, (2) if training data is not assigned, (3) if
            feature impact job is in progress for custom model.'
      summary: Get custom model feature impact.
      tags:
      - models
      x-versionadded: v2.20
    post:
      description: "Add a request to calculate feature impact for a custom inference\
        \ model image to             the queue.\n\n.. minversion:: v2.23\n    DEPRECATED:\
        \ please use version route instead:\n    :http:post:`/api/v2/customModels/(customModelId)/versions/(customModelVersionId)/featureImpact/`\n\
        \nThis route is a counterpart of a corresponding endpoint for native models:\n\
        :http:post:`/api/v2/projects/(projectId)/models/(modelId)/featureImpact/`\n"
      operationId: customInferenceImagesFeatureImpact_create
      parameters:
      - description: ID of the image of the custom inference model to submit feature
          impact job for.
        in: path
        name: imageId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureImpactCreatePayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureImpactCreateResponse'
          description: Feature impact request has been successfully submitted.
          headers:
            Location:
              description: 'Contains a url for tracking job status: :http:get:`/api/v2/status/(statusId)/`.'
              schema:
                type: string
        '404':
          description: If feature impact has already been submitted. The response
            will include `jobId` property which can be used for tracking its progress.
        '422':
          description: 'If job cannot be submitted because of invalid input or model
            state: (1) if image id does not correspond to a custom inference model,
            (2) if training data is not yet assigned or assignment is in progress,
            (3) if the `rowCount` exceeds the minimum or maximum value for this model''s
            training data.'
      summary: Create custom model feature impact.
      tags:
      - models
      x-versionadded: v2.20
  /api/v2/customJobLimits/:
    get:
      description: Retrieve custom job limits.
      operationId: customJobLimits_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobLimitsResponse'
          description: Custom job limits
        '403':
          description: Custom jobs are not enabled.
      summary: Retrieve custom job limits.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/:
    get:
      description: List custom jobs.
      operationId: customJobs_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Whether only custom jobs that are currently being run should
          be returned.
        in: query
        name: onlyRunning
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: If supplied, only include custom jobs whose name or description
          contain this string.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          type: string
      - description: The type of the custom job to filter by.
        in: query
        name: jobType
        required: false
        schema:
          items:
            enum:
            - default
            - hostedCustomMetric
            - notification
            - retraining
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobListResponse'
          description: List of custom jobs.
        '403':
          description: Custom jobs are not enabled.
      summary: List custom jobs.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    post:
      description: Create a custom job.
      operationId: customJobs_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomJob'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobResponse'
          description: Created.
        '403':
          description: Custom jobs are not enabled.
        '422':
          description: Input parameters are invalid.
      summary: Create a custom job.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/:
    delete:
      description: Delete custom job.
      operationId: customJobs_delete
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Custom job deleted.
        '403':
          description: Custom jobs are not enabled.
      summary: Delete custom job.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    get:
      description: Retrieve custom job.
      operationId: customJobs_retrieve
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobResponse'
          description: Custom job
        '403':
          description: Custom jobs are not enabled.
      summary: Retrieve custom job.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    patch:
      description: Update custom job.
      operationId: customJobs_patch
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomJob'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobResponse'
          description: Updated custom job
        '403':
          description: Custom jobs are not enabled.
        '422':
          description: Input parameters are invalid.
      summary: Update custom job.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/items/{itemId}/:
    get:
      description: Retrieve custom job file content.
      operationId: customJobsItems_retrieve
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the file item.
        in: path
        name: itemId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobFileResponse'
          description: Custom job file content
        '403':
          description: Custom jobs are not enabled.
        '404':
          description: No file found.
        '422':
          description: File is not utf-8 encoded.
      summary: Retrieve custom job file content.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/runs/:
    get:
      description: List custom job runs.
      operationId: customJobsRuns_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: If supplied, only include custom job runs that are scheduled
          with this scheduled job id.
        in: query
        name: scheduledJobId
        required: false
        schema:
          type: string
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobRunListResponse'
          description: List of custom job runs.
        '403':
          description: Custom jobs are not enabled.
      summary: List custom job runs.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    post:
      description: Create a custom job run.
      operationId: customJobsRuns_create
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomJobRun'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobRunResponse'
          description: Created.
        '403':
          description: Custom jobs are not enabled.
        '422':
          description: Input parameters are invalid.
      summary: Create a custom job run.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/:
    delete:
      description: Cancel custom job run.
      operationId: customJobsRuns_delete
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom job run.
        in: path
        name: customJobRunId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Custom job run canceled
        '403':
          description: Custom jobs are not enabled.
        '422':
          description: Input parameters are invalid.
      summary: Cancel custom job run.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    get:
      description: Retrieve custom job run.
      operationId: customJobsRuns_retrieve
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom job run.
        in: path
        name: customJobRunId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobRunResponse'
          description: Custom job run
        '403':
          description: Custom jobs are not enabled.
      summary: Retrieve custom job run.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    patch:
      description: Update custom job run.
      operationId: customJobsRuns_patch
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom job run.
        in: path
        name: customJobRunId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomJobRun'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobRunResponse'
          description: Updated custom job run
        '403':
          description: Custom jobs are not enabled.
        '422':
          description: Input parameters are invalid.
      summary: Update custom job run.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/items/{itemId}/:
    get:
      description: Retrieve custom job run file content.
      operationId: customJobsRunsItems_retrieve
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom job run.
        in: path
        name: customJobRunId
        required: true
        schema:
          type: string
      - description: ID of the file item.
        in: path
        name: itemId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobFileResponse'
          description: Custom job run file content
        '403':
          description: Custom jobs are not enabled.
        '404':
          description: No file found.
        '422':
          description: File is not utf-8 encoded.
      summary: Retrieve custom job run file content.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/logs/:
    delete:
      description: Delete custom job run logs.
      operationId: customJobsRunsLogs_deleteMany
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom job run.
        in: path
        name: customJobRunId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Custom job run logs deleted.
        '404':
          description: No log found.
      summary: De,ete custom job run logs.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    get:
      description: Retrieve custom job run logs.
      operationId: customJobsRunsLogs_list
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom job run.
        in: path
        name: customJobRunId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The log file download.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=custom-job-run-<custom_job_id>-<custom_job_run_id>.log").
              schema:
                type: string
        '404':
          description: No log found.
      summary: Retrieve custom job run logs.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this custom job and their roles on the custom job.
      operationId: customJobsSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The Custom Job's access control list.
        '404':
          description: Either the Custom Job does not exist or the user does not have
            permissions to view the Custom Job.
        '422':
          description: Both username and userId were specified
      summary: Get Custom Job's access control list
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
    patch:
      description: Set roles for users on this custom job.
      operationId: customJobsSharedRoles_patchMany
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the custom job without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update Custom Job's controls
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customJobsCleanup/{customJobId}/:
    post:
      description: Permanently delete custom job.
      operationId: customJobsCleanup_createOne
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Custom job permanently deleted.
        '401':
          description: Permadelete not enabled or user not permitted to permadelete.
        '403':
          description: Custom jobs are not enabled.
        '409':
          description: At least one of the custom job componenets are not soft-deleted,
            therefore can not permanently delete.
      summary: Permanently delete custom job.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/customModelDeployments/:
    get:
      description: List of model deployments for user sorted by creation time descending.
      operationId: customModelDeployments_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: List of ID's of the custom model which model deployments will
          be retrieved.
        in: query
        name: customModelIds
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: List of ID's of the execution environment which model deployments
          will be retrieved.
        in: query
        name: environmentIds
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelDeploymentListResponse'
          description: OK.
        '400':
          description: Query parameters are invalid.
      summary: List custom model deployments.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModelDeployments/{deploymentId}/logs/:
    get:
      description: Retrieve the logs generated during deployment of the custom model.
      operationId: customModelDeploymentsLogs_list
      parameters:
      - description: ID of the custom model deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the Custom Model deployment log.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename of the log file ("attachment;filename=deployment-<deployment_id>.log").
              schema:
                type: string
        '404':
          description: No logs found.
      summary: Get custom model log.
      tags:
      - custom_models
      x-versionadded: v2.30
    post:
      description: Request logs from a custom deployed model.
      operationId: customModelDeploymentsLogs_create
      parameters:
      - description: ID of the custom model deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelAsyncOperationResponse'
          description: 'Accepted: request placed to a queue for processing.'
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '404':
          description: Deployment not found or model is not a Custom Model.
        '422':
          description: Deployed model is not a Custom Model.
      summary: Get custom model log.
      tags:
      - custom_models
      x-versionadded: v2.30
  /api/v2/customModelDeployments/{deploymentId}/logs/{logId}/:
    get:
      description: Retrieve the logs generated during predictions on the deployed
        custom model.
      operationId: customModelDeploymentsLogs_retrieve
      parameters:
      - description: ID of the custom model deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom model deployment log.
        in: path
        name: logId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the Custom Model deployment log.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename of the log file ("attachment;filename=deployment-<deployment_id>.log").
              schema:
                type: string
        '404':
          description: No logs found.
      summary: Get custom model log.
      tags:
      - custom_models
      x-versionadded: v2.30
  /api/v2/customModelLimits/:
    get:
      description: Retrieve custom model resource limits the user has access to.
      operationId: customModelLimits_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelResourceLimits'
          description: OK.
      summary: Get custom model resource limits.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModelTests/:
    get:
      description: Retrieve the testing history for a model.
      operationId: customModelTests_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: 'A single identifier that represents a bundle of resources: Memory,
          CPU, GPU, etc. A list of available bundles can be obtained via the resource
          bundles endpoint.'
        in: query
        name: resourceBundleId
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.33
      - description: The maximum memory that might be allocated by the custom-model.
          If exceeded, the custom-model will be killed. This setting is incompatible
          with setting the resourceBundleId.
        in: query
        name: maximumMemory
        required: false
        schema:
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
      - description: Network egress policy.
        in: query
        name: networkEgressPolicy
        required: false
        schema:
          enum:
          - NONE
          - PUBLIC
          nullable: true
          type: string
      - description: The amount of memory that is expected to be allocated by the
          custom model. This setting is incompatible with setting the resourceBundleId.
        in: query
        name: desiredMemory
        required: false
        schema:
          maximum: 15032385536
          minimum: 134217728
          nullable: true
          type: integer
        x-versiondeprecated: v2.24
      - description: A fixed number of replicas that will be set for the given custom-model.
        in: query
        name: replicas
        required: false
        schema:
          exclusiveMinimum: true
          maximum: 8
          minimum: 0
          nullable: true
          type: integer
      - description: Require all custom model replicas to be deployed on different
          Kubernetes nodes for predictions fault tolerance.
        in: query
        name: requiresHa
        required: false
        schema:
          nullable: true
          type: boolean
        x-versionadded: v2.26
      - description: ID of the Custom Model to retrieve testing history for.
        in: query
        name: customModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelTestsListResponse'
          description: OK.
      summary: List custom model tests.
      tags:
      - custom_models
      x-versionadded: v2.24
    post:
      description: Test a custom inference model. This will start a job to check that
        the custom model can make predictions against the supplied dataset without
        breaking.
      operationId: customModelTests_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelTests'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelAsyncOperationResponse'
          description: Model testing job successfully started.
          headers:
            Location:
              description: URL that can be polled to check the status.
              schema:
                type: string
        '403':
          description: No access to use data for testing custom model.
        '404':
          description: Custom model or dataset not found.
        '422':
          description: 'Custom Model Testing cannot be submitted because of invalid
            input or model state: (1) if user does not have permission to create legacy
            conversion environment, (2) testing is already in progress for the custom
            model, (3) dataset used for testing is not snapshotted,(4) other cases.'
      summary: Create custom model test.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModelTests/{customModelTestId}/:
    delete:
      description: Cancel custom inference model testing.
      operationId: customModelTests_delete
      parameters:
      - description: ID of the testing history attempt.
        in: path
        name: customModelTestId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Testing canceled.
        '404':
          description: Testing attempt not found.
        '409':
          description: Testing attempt has already reached a terminal state.
      summary: Cancel custom model test.
      tags:
      - custom_models
      x-versionadded: v2.24
    get:
      description: Retrieve a specific testing history entry for a custom model.
      operationId: customModelTests_retrieve
      parameters:
      - description: ID of the testing history attempt.
        in: path
        name: customModelTestId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelTestsResponse'
          description: OK.
      summary: Get custom model test.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModelTests/{customModelTestId}/log/:
    get:
      description: Retrieve the logs from a model testing attempt.
      operationId: customModelTestsLog_list
      parameters:
      - description: ID of the testing history attempt.
        in: path
        name: customModelTestId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The log file will be downloaded.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=testing-<custom_model_id>.log").
              schema:
                type: string
        '404':
          description: No testing log found.
      summary: Get custom model test log.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModelTests/{customModelTestId}/tail/:
    get:
      description: Retrieve the last N lines of logs from a model testing attempt.
      operationId: customModelTestsTail_list
      parameters:
      - description: Number of lines from the log to retrieve (1-1000, default 100).
        in: query
        name: lines
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: ID of the testing history attempt.
        in: path
        name: customModelTestId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelTestsLogTailResponse'
          description: The log tail was retrieved.
        '400':
          description: Requested number of lines is invalid.
        '404':
          description: The testing history entry cannot be found.
      summary: Get custom model test log tail.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModels/:
    get:
      description: Retrieve metadata for all custom models the user has access to.
      operationId: customModels_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: If "training" specified, only Custom Training Tasks will be returned.
          If "inference" specified, only Custom Inference Models will be returned.
          If not specified, all custom models will be returned. After deprecation,
          only Custom Inference Models will be returned
        in: query
        name: customModelType
        required: false
        schema:
          enum:
          - training
          - inference
          type: string
        x-versiondeprecated: '2.28'
      - description: If "true" specified, only deployed custom models will be returned.
          If "false" specified, only not deployed custom models will be returned.
          If not specified, all custom models will be returned.
        in: query
        name: isDeployed
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Sort order which will be applied to custom model list, valid
          options are "created", "updated". Prefix the attribute name with a dash
          to sort in descending order, e.g. orderBy="-created". By default, the orderBy
          parameter is None which will result in custom models being returned in order
          of creation time descending.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - created
          - -created
          - updated
          - -updated
          type: string
      - description: String to search for occurrence in custom model's description,
          language and name. Search is case insensitive. If not specified, all custom
          models will be returned.
        in: query
        name: searchFor
        required: false
        schema:
          maxLength: 10000
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelListResponse'
          description: OK.
      summary: List custom models.
      tags:
      - custom_models
      x-versionadded: v2.24
    post:
      description: "\nCreates a new custom model and returns the newly created metadata\
        \ record for it.\n\nAll custom models must support at least one target type\
        \ (binaryClassification, regression).\nCustom inference models can only support\
        \ a single target type.  A regression model is\nexpected to produce predictions\
        \ that are arbitrary floating-point or integer numbers.\nA classification\
        \ model is expected to return predictions with probability scores for each\n\
        class.  For example, a binary classification model might return:\n\n.. code::\
        \ Python\n\n    {\n        positiveClassLabel: probability,\n        negativeClassLabel:\
        \ 1.0 - probability\n    }\n\nFor Custom Inference Models, the ``file`` parameter\
        \ must be either a tarball or zip archive\ncontaining, at minimum,\na script\
        \ named ``start_server.sh``.  It may contain additional files, including scripts\
        \ and\nprecompiled binaries as well as data files.  ``start_server.sh`` may\
        \ execute these scripts\nand/or binaries.  When this script is executed, it\
        \ is run as part of an Environment\n(specified via subsequent API calls),\
        \ and all included scripts and binaries\ncan take advantage of any programming\
        \ language interpreters, compilers, libraries,\nor other tools included in\
        \ the Environment. ``start_server.sh`` must be marked as executable\n(``chmod\
        \ +x``).\n\nWhen ``start_server.sh`` is launched, it must launch and maintain\n\
        (in the foreground) a Web server that listens on two URLs:\n\n* ``GET $URL_PREFIX/``\n\
        \    This route must return a 200 response code with an empty body immediately\n\
        \    if the server is ready to respond to prediction requests.  Otherwise\
        \ it should\n    either not accept the request, not respond to the request,\
        \ or return a\n    503 response code.\n* ``POST $URL_PREFIX/predict_no_state/``\n\
        \    This route must accept as input a JSON object of the form:\n\n    ..\
        \ code-block:: Python\n\n        {\n            'X': {\n                'col1':\
        \ [...col1_data...],\n                'col2': [...col2_data...],\n       \
        \         'col3': [...col3_data...],\n                ...\n            }\n\
        \        }\n\n    The data lists will all be the same length.\n\n    It must\
        \ return a JSON object of the form:\n\n    .. code-block:: Python\n\n    \
        \    {\n            'predictions': [...predictions data...]\n        }\n\n\
        \    The predictions data must correspond 1:1 to the rows in the input data\
        \ lists.\n\n    ``$URL_PREFIX`` is provided as an environment variable.  The\
        \ Web server process must\n    re-read its value every time the process starts,\
        \ as it may change.\n    It is an opaque string that is guaranteed to be a\
        \ valid URL component,\n    but may contain path separators (``/``).\n"
      operationId: customModels_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelResponse'
          description: Created.
        '403':
          description: Custom model creation is not enabled.
        '422':
          description: Input parameters are invalid.
      summary: Create custom model.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModels/fromCustomModel/:
    post:
      description: Creates a copy of the provided custom model, including metadata,
        versions of that model, and uploaded files. Associates the new versions with
        files owned by the custom model.
      operationId: customModelsFromCustomModel_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelCopy'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelResponse'
          description: Successfully created copy.
      summary: Clone custom model.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModels/predictionExplanationsInitialization/:
    post:
      description: "Create a new prediction explanations initialization for custom\
        \ model.\nThis is a necessary prerequisite for generating prediction explanations.\n\
        \n.. minversion:: v2.23\n    DEPRECATED please use custom model version route\
        \ instead:\n    :http:post:`/api/v2/customModels/(customModelId)/versions/(customModelVersionId)/predictionExplanationsInitialization/`\n"
      operationId: customModelsPredictionExplanationsInitialization_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelPredictionExplanations'
      responses:
        '202':
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: URL to poll to track the prediction explanation initialization
                has finished.
              schema:
                type: string
        '422':
          description: Specified custom model is not valid for prediction explanations.
      summary: Create a new prediction explanations initialization for custom model.
      tags:
      - custom_models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/:
    delete:
      description: Delete a custom model. Only users who have permission to edit custom
        model can delete it. Only custom models which are not currently deployed or
        undergoing custom model testing can be deleted. Relevant CustomModelImage
        will be deleted also.
      operationId: customModels_delete
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Record deleted.
        '409':
          description: This custom model is currently deployed and cannot be deleted.
            The response body will contain link where those deployments can be retrieved.
      summary: Delete custom model.
      tags:
      - custom_models
      x-versionadded: v2.24
    get:
      description: Retrieve metadata for a custom model.
      operationId: customModels_retrieve
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelResponse'
          description: OK.
      summary: Get custom model.
      tags:
      - custom_models
      x-versionadded: v2.24
    patch:
      description: '

        Updates metadata for an existing custom model.


        All custom models must support at least one target type (binaryClassification,
        regression).

        Custom inference models can only support a single target type.


        Setting `positiveClassLabel` and `negativeClassLabel` to null will set

        the labels to their default values (1 and 0 for positiveClassLabel and negativeClassLabel,

        respectively).


        Setting `positiveClassLabel`, `negativeClassLabel`, ''targetName` is disabled
        if model

        has active deployments or assigned training data.

        '
      operationId: customModels_patch
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelUpdate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelResponse'
          description: Created.
        '403':
          description: Custom inference model modification is not enabled for the
            user.
        '409':
          description: Custom model cannot be updated while it is being validated
            or some fields cannot be updated after deployment or assigning training
            data.
        '422':
          description: Input parameters are invalid.
      summary: Update custom model.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModels/{customModelId}/accessControl/:
    get:
      description: Get a list of users who have access to this custom model and their
        roles on it.
      operationId: customModelsAccessControl_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelAccessControlListResponse'
          description: A list of users who have access to this custom model and their
            roles on it.
        '400':
          description: Both username and userId were specified.
      summary: Get a list of users who have access to this custom model and their
        roles on it.
      tags:
      - custom_models
      x-versionadded: v2.25
    patch:
      description: Grant access or update roles for users on this custom model and
        appropriate learning data. Up to 100 user roles may be set in a single request.
      operationId: customModelsAccessControl_patchMany
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingUpdateOrRemoveWithGrant'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelAccessControlUpdateResponse'
          description: Roles updated successfully.
        '409':
          description: The request would leave the custom model without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid.
      summary: Grant access or update roles for users on this custom model and appropriate
        learning data.
      tags:
      - custom_models
      x-versionadded: v2.25
  /api/v2/customModels/{customModelId}/download/:
    get:
      description: Download the latest item bundle from a custom model as a zip compressed
        archive.
      operationId: customModelsDownload_list
      parameters:
      - description: Download model version from PPS tab.If "true" specified, model
          archive includes dependencies install script. If "false" specified, dependencies
          script is not included. If not specified -> "false" behavior.
        in: query
        name: pps
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The download succeeded.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=model-<model_id>-version-<version_id>.zip").
              schema:
                type: string
      summary: Download the latest custom model version content.
      tags:
      - custom_models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/trainingData/:
    patch:
      description: "The current API is deprecated and scheduled for removal in v2.34.\
        \             Training data assignment is implemented in CustomModelVersionCreateController\
        \ and CustomModelVersionCreateFromLatestController.\n\nAssigns the specified\
        \ dataset to the specified custom model as training data.\nFor each of the\
        \ custom model's deployments, the training data from the specified project\n\
        provides a baseline to enable drift tracking. \nThe API is disabled and returns\
        \ HTTP 422\nwhen a custom model is converted to assign training data at the\
        \ version level.             See isTrainingDataForVersionsPermanentlyEnabled\
        \ parameter for             :http:post:`/api/v2/customModels/`           \
        \  and             :http:patch:`/api/v2/customModels/(customModelId)/` \n\
        Use training data assignment at the version level:             :http:post:`/api/v2/customModels/(customModelId)/versions/`\
        \             :http:patch:`/api/v2/customModels/(customModelId)/versions/`\
        \         "
      operationId: customModelsTrainingData_patchMany
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeprecatedTrainingDataForModelsAssignment'
      responses:
        '202':
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: URL to poll to track the training data assignment has finished.
              schema:
                type: string
        '409':
          description: Custom model has assigned training data already and is deployed.
        '410':
          description: The requested Dataset has been deleted.
        '422':
          description: Dataset ingest must finish before assigning training data or
            provided dataset is incompatible with the custom model.
      summary: Assign training data to custom model.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModels/{customModelId}/versions/:
    get:
      description: List custom model versions.
      operationId: customModelsVersions_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Specifies the commit SHA-1 in GitHub repository from the main
          branch that corresponds to a given custom model version.
        in: query
        name: mainBranchCommitSha
        required: false
        schema:
          maxLength: 40
          minLength: 40
          type: string
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVersionListResponse'
          description: OK.
        '400':
          description: Query parameters are invalid.
        '422':
          description: Input parameters are invalid.
      summary: List custom model versions.
      tags:
      - custom_models
      x-versionadded: v2.22
    patch:
      description: Create a new custom model version with files added, replaced or
        deleted. Files from the previous version of a custom models will be used as
        a basis.
      operationId: customModelsVersion_createFromLatest
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomModelVersionCreateFromLatest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVersionResponse'
          description: Item successfully created.
        '403':
          description: User does not have permissions to use requested Dataset
        '404':
          description: Either custom model or dataset not found or user does not have
            edit permissions.
        '413':
          description: Item or collection of items was too large in size (bytes).
        '422':
          description: 'Cannot create the custom task version due to one or more errors.
            All error responses will have a "message" field and some may have optional
            fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"]'
      summary: Update custom model version files.
      tags:
      - custom_models
      x-versionadded: v2.22
    post:
      description: Create a new custom model version with attached files if supplied.
      operationId: customModelsVersions_create
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomModelVersionCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVersionResponse'
          description: Item successfully created.
        '403':
          description: User does not have permissions to use requested Dataset
        '404':
          description: Either custom model or dataset not found or user does not have
            edit permissions.
        '413':
          description: Item or collection of items was too large in size (bytes).
        '422':
          description: 'Cannot create the custom task version due to one or more errors.
            All error responses will have a "message" field and some may have optional
            fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"]'
      summary: Create custom model version.
      tags:
      - custom_models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/versions/fromRepository/:
    patch:
      description: Create a new custom model version with files added from a remote
        repository. Files from the previous version of a custom models will be used
        as a basis.
      operationId: customModelsVersionsFromRepository_patchMany
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelVersionCreateFromRepository'
      responses:
        '202':
          description: 'Accepted: request placed to a queue for processing.'
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: 'Custom Model version cannot be created: (1) input parameters
            are invalid, (2) if user does not have permission to create legacy conversion
            environment.'
      summary: Create custom model version from remote repository with files from
        previous version.
      tags:
      - custom_models
      x-versionadded: v2.24
    post:
      description: Create a new custom model version with only files added from the
        specified remote repository.
      operationId: customModelsVersionsFromRepository_create
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelVersionCreateFromRepository'
      responses:
        '202':
          description: 'Accepted: request placed to a queue for processing.'
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: 'Custom Model version cannot be created: (1) input parameters
            are invalid, (2) if user does not have permission to create legacy conversion
            environment.'
      summary: Create custom model version from remote repository.
      tags:
      - custom_models
      x-versionadded: v2.24
  /api/v2/customModels/{customModelId}/versions/withTrainingData/:
    patch:
      description: "Current API is deprecated and will be removed in v2.33.      \
        \       Training data assignment is implemented in CustomModelVersionCreateController\
        \ and CustomModelVersionCreateFromLatestController.\n\nCreates a new custom\
        \ model version (bumping it up a **minor** version) with the specified training\
        \ and holdout data.\nThis functionality has to be explicitly enabled for the\
        \ current model. \nSee isTrainingDataForVersionsPermanentlyEnabled parameter\
        \ for             :http:post:`/api/v2/customModels/`             and     \
        \        :http:patch:`/api/v2/customModels/(customModelId)/` \nThis API is\
        \ going to be deprecated.\nUse model version creation APIs to assign training\
        \ data at the version level:             :http:post:`/api/v2/customModels/(customModelId)/versions/`\
        \             :http:patch:`/api/v2/customModels/(customModelId)/versions/`\
        \             "
      operationId: customModelsVersionsWithTrainingData_patchMany
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeprecatedCustomModelVersionTrainingDataUpdate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVersionResponse'
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: URL to poll to track the training data assignment has finished.
              schema:
                type: string
        '404':
          description: Custom model not found or user does not have edit permissions.
        '410':
          description: The requested Dataset has been deleted.
        '422':
          description: Cannot update custom model training data.
      summary: Add or replace training and holdout data for a model version.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables maintaining custom model versioning information, including
          for deployed models, after new training and holdout data has been added.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_MODEL_TRAINING_AND_HOLDOUT_DATA_FOR_MODEL_VERSIONS
      x-versionadded: v2.30
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/:
    get:
      description: Display a requested version of a custom model along with the files
        attached to it.
      operationId: customModelsVersions_retrieve
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVersionResponse'
          description: OK.
      summary: Get custom model version.
      tags:
      - custom_models
      x-versionadded: v2.22
    patch:
      description: Edit metadata of a specific model version.
      operationId: customModelsVersions_patch
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelVersionMetadataUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVersionResponse'
          description: The edit was successful.
        '404':
          description: Custom model not found or user does not have edit permissions.
        '422':
          description: Cannot update custom model metadata.
      summary: Update custom model version.
      tags:
      - custom_models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/:
    get:
      description: Get the list of custom model conversions that are associated with
        the given custom model. Alternatively, it can return a single item list of
        the latest custom model conversion that is associated with the given custom
        model version.
      operationId: customModelsVersionsConversions_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Whether to return only the latest associated custom model conversion
          or all of the associated ones.
        in: query
        name: isLatest
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionListResponse'
          description: ''
      summary: Get a list or latest custom model conversion(s).
      tags:
      - custom_models
      x-versionadded: v2.27
    post:
      description: Converts files in the given custom model version to a JAR file.
      operationId: customModelsVersionsConversions_create
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversionCreateQuery'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelConversionAsyncOperationResponse'
          description: The request was accepted and will be worked on.
        '422':
          description: Input parameters are invalid.
      summary: Generates JAR file from particular files.
      tags:
      - custom_models
      x-versionadded: v2.27
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/:
    delete:
      description: Stop a running conversion for given model and model version.
      operationId: customModelsVersionsConversions_delete
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      - description: ID of the custom model conversion.
        in: path
        name: conversionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '422':
          description: The given conversion is not active.
      summary: Stop a given custom model conversion.
      tags:
      - custom_models
      x-versionadded: v2.27
    get:
      description: Get a given custom model conversion.
      operationId: customModelsVersionsConversions_retrieve
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      - description: ID of the custom model conversion.
        in: path
        name: conversionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionResponse'
          description: ''
      summary: Get a given custom model conversion.
      tags:
      - custom_models
      x-versionadded: v2.27
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/:
    delete:
      description: Cancel the custom model version's dependency build.
      operationId: customModelsVersionsDependencyBuild_deleteMany
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Custom model version's dependency build was cancelled.
        '409':
          description: Custom model dependency build has reached a terminal state
            and cannot be cancelled.
        '422':
          description: No custom model dependency build started for specified version
            or dependency image is in use and cannot be deleted
      summary: Cancel dependency build.
      tags:
      - models
      x-versionadded: v2.22
    get:
      description: Retrieve the custom model version's dependency build status.
      operationId: customModelsVersionsDependencyBuild_list
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseDependencyBuildMetadataResponse'
          description: The metadata from the custom model version's dependency build.
        '422':
          description: Custom model dependency build has not started.
      summary: Retrieve the custom model version's dependency build status.
      tags:
      - models
      x-versionadded: v2.22
    post:
      description: Start a custom model version's dependency build. This is required
        to test, deploy, or train custom models.
      operationId: customModelsVersionsDependencyBuild_create
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseDependencyBuildMetadataResponse'
          description: Custom model version's dependency build has started.
        '422':
          description: Custom model dependency build has failed.
      summary: Start a custom model version's dependency build.
      tags:
      - models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuildLog/:
    get:
      description: Retrieve the custom model version's dependency build log.
      operationId: customModelsVersionsDependencyBuildLog_list
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyBuildLogResponse'
          description: The log file generated during the custom model version's dependency
            build.
        '404':
          description: Dependency build is in progress or could not be found.
        '422':
          description: Custom model dependency build has not started.
      summary: Retrieve the custom model version's dependency build log.
      tags:
      - models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/download/:
    get:
      description: Download a specific item bundle from a custom model as a zip compressed
        archive.
      operationId: customModelsVersionsDownload_list
      parameters:
      - description: Download model version from PPS tab.If "true" specified, model
          archive includes dependencies install script. If "false" specified, dependencies
          script is not included. If not specified -> "false" behavior.
        in: query
        name: pps
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The download succeeded.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=model-<model_id>-version-<version_id>.zip").
              schema:
                type: string
      summary: Download custom model version content.
      tags:
      - custom_models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/:
    get:
      description: 'Retrieve feature impact scores for features in a custom inference
        model image.



        This route is a counterpart of a corresponding endpoint for native models:

        :http:get:`/api/v2/projects/(projectId)/models/(modelId)/featureImpact/`

        '
      operationId: customModelsVersionsFeatureImpact_list
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureImpactResponse'
          description: Custom model feature impact returned.
        '404':
          description: No feature impact data found for custom model.
        '422':
          description: 'Cannot retrieve feature impact scores: (1) if custom model
            is not an inference model, (2) if training data is not assigned, (3) if
            feature impact job is in progress for custom model.'
      summary: Get custom model feature impact.
      tags:
      - custom_models
      x-versionadded: v2.23
    post:
      description: 'Add a request to calculate feature impact for a custom inference
        model image to             the queue.


        This route is a counterpart of a corresponding endpoint for native models:

        :http:post:`/api/v2/projects/(projectId)/models/(modelId)/featureImpact/`

        '
      operationId: customModelsVersionsFeatureImpact_create
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureImpactCreatePayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureImpactCreateResponse'
          description: Feature impact request has been successfully submitted.
          headers:
            Location:
              description: 'Contains a url for tracking job status: :http:get:`/api/v2/status/(statusId)/`.'
              schema:
                type: string
        '404':
          description: If feature impact has already been submitted. The response
            will include `jobId` property which can be used for tracking its progress.
        '422':
          description: 'If job cannot be submitted because of invalid input or model
            state: (1) if image id does not correspond to a custom inference model,
            (2) if training data is not yet assigned or assignment is in progress,
            (3) if the `rowCount` exceeds the minimum or maximum value for this model''s
            training data.'
      summary: Create custom model feature impact.
      tags:
      - custom_models
      x-versionadded: v2.23
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/predictionExplanationsInitialization/:
    post:
      description: Create a new prediction explanations initialization for custom
        model version. This is a necessary prerequisite for generating prediction
        explanations.
      operationId: customModelsVersionsPredictionExplanationsInitialization_create
      parameters:
      - description: ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '202':
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: URL to poll to track the prediction explanation initialization
                has finished.
              schema:
                type: string
        '422':
          description: Specified custom model is not valid for prediction explanations.
      summary: Create a new prediction explanations initialization for custom model
        version.
      tags:
      - custom_models
      x-versionadded: v2.23
  /api/v2/customTasks/:
    get:
      description: Retrieve metadata for all custom tasks the user has access to.
      operationId: customTasks_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Sort order which will be applied to custom task list, valid options
          are "created", "updated". Prefix the attribute name with a dash to sort
          in descending order, e.g. orderBy="-created". By default, the orderBy parameter
          is None which will result in custom tasks being returned in order of creation
          time descending.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - created
          - -created
          - updated
          - -updated
          type: string
      - description: String to search for occurrence in custom task's description,
          language and name. Search is case insensitive. If not specified, all custom
          tasks will be returned.
        in: query
        name: searchFor
        required: false
        schema:
          maxLength: 10000
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskListResponse'
          description: OK.
      summary: List custom tasks.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    post:
      description: "\nCreates a new custom task and returns the newly created metadata\
        \ record for it.\n\nA custom task may either be an estimator or a transform.\
        \ Estimators must support a single\ntarget type (e.g. binaryClassification,\
        \ regression).\nRegression and anomaly detection models are\nexpected to produce\
        \ predictions that are arbitrary floating-point or integer numbers.\nA classification\
        \ model is expected to return predictions with probability scores for each\n\
        class.  For example, a binary classification model might return:\n\n.. code::\
        \ Python\n\n    {\n        positiveClassLabel: probability,\n        negativeClassLabel:\
        \ 1.0 - probability\n    }\n\nTransforms are expected to return a dataframe\
        \ or sparse matrix with the same number\nof rows as the input feature matrix.\
        \ At this time, only numeric outputs are supported\nfor custom transforms.\n"
      operationId: customTasks_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTaskCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskResponse'
          description: Custom task successfully created.
        '403':
          description: Custom task creation is not enabled.
        '422':
          description: Input parameters invalid
      summary: Create a custom task
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/fromCustomTask/:
    post:
      description: Creates a copy of the provided custom task, including metadata,
        versions of that task, and uploaded files. Associates the new versions with
        files owned by the custom task.
      operationId: customTasksFromCustomTask_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTaskCopy'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskResponse'
          description: Successfully created copy.
      summary: Clone custom task.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/{customTaskId}/:
    delete:
      description: Delete a custom task. Only users who have permission to edit custom
        task can delete it. Only custom tasks which are not currently deployed, used
        in a blueprint, or in the AIcatalog can be deleted. Relevant CustomTaskImage
        will be deleted also.
      operationId: customTasks_delete
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Record deleted.
        '409':
          description: This custom task is currently deployed, trained, or part of
            a user blueprint, and cannot be deleted. The response body will contain
            link where these conflicts can be retrieved.
      summary: Delete custom task.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    get:
      description: Retrieve metadata for a custom task
      operationId: customTasks_retrieve
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskResponse'
          description: OK.
      summary: Get custom task.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    patch:
      description: '

        Updates metadata for an existing custom task.


        All custom tasks must support one target type (e.g. binaryClassification,
        regression, transform).


        Setting `positiveClassLabel` and `negativeClassLabel` to null will set

        the labels to their default values (1 and 0 for positiveClassLabel and negativeClassLabel,

        respectively).


        Setting `positiveClassLabel`, `negativeClassLabel`, `targetName` is disabled
        if task

        has active deployments.

        '
      operationId: customTasks_patch
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTaskUpdate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskResponse'
          description: Created.
        '422':
          description: Input parameters are invalid.
      summary: Update custom task.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/{customTaskId}/accessControl/:
    get:
      description: Get a list of users who have access to this custom task and their
        roles on it.
      operationId: customTasksAccessControl_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskAccessControlListResponse'
          description: A list of users who have access to this custom task and their
            roles on it.
        '400':
          description: Both username and userId were specified.
      summary: Get a list of users who have access to this custom task and their roles
        on it.
      tags:
      - custom_tasks
      x-versionadded: v2.27
    patch:
      description: Grant access or update roles for users on this custom task and
        appropriate learning data. Up to 100 user roles may be set in a single request.
      operationId: customTasksAccessControl_patchMany
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingUpdateOrRemoveWithGrant'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the custom task without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid.
      summary: Grant access or update roles for users on this custom task and appropriate
        learning data.
      tags:
      - custom_tasks
      x-versionadded: v2.27
  /api/v2/customTasks/{customTaskId}/download/:
    get:
      description: Download the latest item bundle from a custom task as a zip compressed
        archive.
      operationId: customTasksDownload_list
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The download succeeded.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=model-<model_id>-version-<version_id>.zip").
              schema:
                type: string
      summary: Download the latest custom task version content.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/{customTaskId}/versions/:
    get:
      description: List custom task versions.
      operationId: customTasksVersions_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionListResponse'
          description: OK.
        '400':
          description: Query parameters are invalid.
      summary: List custom task versions.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    patch:
      description: Create a new custom task version with files added, replaced or
        deleted. Files from the previous version of a custom task will be used as
        a basis.
      operationId: customTaskVersion_createFromLatest
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomTaskVersionCreateFromLatest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionResponse'
          description: Item successfully created.
        '413':
          description: Item or collection of items was too large in size (bytes).
        '422':
          description: 'Cannot create the custom task version due to one or more errors.
            All error responses will have a "message" field and some may have optional
            fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"]'
      summary: Update custom task version files.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    post:
      description: Create a new custom task version with attached files if supplied.
      operationId: customTasksVersions_create
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomTaskVersionCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionResponse'
          description: Item successfully created.
        '413':
          description: Item or collection of items was too large in size (bytes).
        '422':
          description: 'Cannot create the custom task version due to one or more errors.
            All error responses will have a "message" field and some may have optional
            fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"]'
      summary: Create custom task version.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/{customTaskId}/versions/fromRepository/:
    patch:
      description: Create a new custom task version with files added from a remote
        repository. Files from the previous version of a custom task will be used
        as a basis.
      operationId: customTasksVersionsFromRepository_patchMany
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTaskVersionCreateFromRepository'
      responses:
        '202':
          description: 'Accepted: request placed to a queue for processing.'
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: Input parameters are invalid.
      summary: Create custom task version from remote repository with files from previous
        version.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    post:
      description: Create a new custom task version with only files added from the
        specified remote repository.
      operationId: customTasksVersionsFromRepository_create
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTaskVersionCreateFromRepository'
      responses:
        '202':
          description: 'Accepted: request placed to a queue for processing.'
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: Input parameters are invalid.
      summary: Create custom task version from remote repository.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/:
    get:
      description: Display a requested version of a custom task along with the files
        attached to it.
      operationId: customTasksVersions_retrieve
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionResponse'
          description: OK.
      summary: Get custom task version.
      tags:
      - custom_tasks
      x-versionadded: v2.26
    patch:
      description: Edit metadata of a specific task version.
      operationId: customTasksVersions_patch
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTaskVersionMetadataUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionResponse'
          description: The edit was successful.
        '404':
          description: Custom task not found or user does not have edit permissions.
      summary: Update custom task version.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/:
    delete:
      description: Cancel the custom task version's dependency build.
      operationId: customTasksVersionsDependencyBuild_deleteMany
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Custom task version's dependency build was cancelled.
        '409':
          description: Custom task dependency build has reached a terminal state and
            cannot be cancelled.
        '422':
          description: No custom task dependency build started for specified version
            or dependency image is in use and cannot be deleted
      summary: Cancel dependency build.
      tags:
      - custom_tasks
      x-versionadded: v2.27
    get:
      description: Retrieve the custom task version's dependency build status.
      operationId: customTasksVersionsDependencyBuild_list
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionDependencyBuildMetadataResponse'
          description: The metadata from the custom task version's dependency build.
        '422':
          description: Custom task dependency build has not started.
      summary: Retrieve the custom task version's dependency build status.
      tags:
      - custom_tasks
      x-versionadded: v2.27
    post:
      description: Start a custom task version's dependency build. This is required
        to test, deploy, or train custom tasks.
      operationId: customTasksVersionsDependencyBuild_create
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTaskVersionDependencyBuildMetadataResponse'
          description: Custom task version's dependency build has started.
        '422':
          description: Custom task dependency build has failed.
      summary: Start a custom task version's dependency build.
      tags:
      - custom_tasks
      x-versionadded: v2.27
  /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuildLog/:
    get:
      description: Retrieve the custom task version's dependency build log.
      operationId: customTasksVersionsDependencyBuildLog_list
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The log file generated during the custom task version's dependency
            build.
        '404':
          description: Dependency build is in progress or could not be found.
        '422':
          description: Custom task dependency build has not started.
      summary: Retrieve the custom task version's dependency build log.
      tags:
      - custom_tasks
      x-versionadded: v2.27
  /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/download/:
    get:
      description: Download a specific item bundle from a custom task as a zip compressed
        archive.
      operationId: customTasksVersionsDownload_list
      parameters:
      - description: ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: ID of the custom task version.
        in: path
        name: customTaskVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The download succeeded.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=model-<model_id>-version-<version_id>.zip").
              schema:
                type: string
      summary: Download custom task version content.
      tags:
      - custom_tasks
      x-versionadded: v2.26
  /api/v2/customTrainingBlueprints/:
    get:
      description: 'List custom training blueprints.


        This route retrieves the metadata for all custom training blueprints             a
        user has access to.

        '
      operationId: customTrainingBlueprints_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: 'List blueprints for a specific model. Default: all.'
        in: query
        name: customModelId
        required: false
        schema:
          type: string
      - description: List blueprints in reverse order.
        in: query
        name: reverse
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Custom model target types to return.
        in: query
        name: targetTypes
        required: false
        schema:
          items:
            enum:
            - Binary
            - Regression
            - Multiclass
            - Anomaly
            - Transform
            - TextGeneration
            - Unstructured
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTrainingBlueprintListResponse'
          description: Custom training blueprint list returned.
      summary: List training blueprints.
      tags:
      - models
      x-versionadded: v2.21
    post:
      description: 'This route creates a blueprint from a custom training estimator
        with an environment

        so that it can be trained via blueprint ID.

        '
      operationId: customTrainingBlueprints_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTrainingBlueprintCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTrainingBlueprintResponse'
          description: Blueprint successfully created.
        '404':
          description: Any of the entities in the request cannot be retrieved.
        '422':
          description: 'Input parameters are invalid: either the custom model is for
            inference or no environment version ID was specified and the given environment
            has no versions.'
      summary: Create a blueprint from a single custom training estimator.
      tags:
      - models
      x-versionadded: v2.21
  /api/v2/dataEngineQueryGenerators/:
    post:
      description: Create a data engine query generator.
      operationId: dataEngineQueryGenerators_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataEngineQueryGenerator'
      responses:
        '202':
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have access to this functionality.
        '422':
          description: Unable to process data engine query generation.
      summary: Create a data engine query generator
      tags:
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/dataEngineQueryGenerators/{dataEngineQueryGeneratorId}/:
    get:
      description: Retrieve a data engine query generator
      operationId: dataEngineQueryGenerators_retrieve
      parameters:
      - description: The ID of the data engine query generator.
        in: path
        name: dataEngineQueryGeneratorId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDataEngineQueryResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Specified query generator was not found.
      summary: Retrieve a data engine query generator given ID.
      tags:
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/dataEngineWorkspaceStates/:
    post:
      description: Create Data Engine workspace state in database.
      operationId: dataEngineWorkspaceStates_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceState'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceSourceCreatedResponse'
          description: The Data Engine Workspace state
        '410':
          description: Specified workspace state was already deleted.
      summary: Create Data Engine workspace state
      tags:
      - ai_catalog
      x-versionadded: v2.21
  /api/v2/dataEngineWorkspaceStates/fromDataEngineQueryGenerator/:
    post:
      description: Create Data Engine workspace state in database from a query generator.
      operationId: dataEngineWorkspaceStatesFromDataEngineQueryGenerator_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceStateFromQueryGenerator'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceStateCreatedFromQueryGeneratorResponse'
          description: The Data Engine Workspace state
      summary: Create Data Engine workspace state from a query generator
      tags:
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/dataEngineWorkspaceStates/{workspaceStateId}/:
    get:
      description: Read and return previously stored Data Engine workspace state.
      operationId: dataEngineWorkspaceStates_retrieve
      parameters:
      - description: The ID of the Data Engine workspace state.
        in: path
        name: workspaceStateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceStateResponse'
          description: The Data Engine workspace state
        '410':
          description: Specified workspace state was already deleted.
      summary: Read Data Engine workspace state
      tags:
      - ai_catalog
      x-versionadded: v2.21
  /api/v2/dataSlices/:
    delete:
      description: Data slices bulk deletion.
      operationId: dataSlices_deleteMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSlicesBulkDeleteRequest'
      responses:
        '204':
          description: The requested data slice(s) are deleted successfully.
      summary: Data slices bulk deletion.
      tags:
      - insights
      x-versionadded: v2.31
    post:
      description: Request to create a new data slice.
      operationId: dataSlices_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSlicesCreationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSliceIndividualResponse'
          description: The requested data slice is created successfully.
      summary: Request to create a new data slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/dataSlices/{dataSliceId}/:
    delete:
      description: Deletes the data slice specified by the data slice ID.
      operationId: dataSlices_delete
      parameters:
      - description: ID of the data slice.
        in: path
        name: dataSliceId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The specified data slice was deleted.
      summary: Delete a data slice.
      tags:
      - insights
      x-versionadded: v2.31
    get:
      description: Returns details about the specified data slice ID.
      operationId: dataSlices_retrieve
      parameters:
      - description: ID of the data slice.
        in: path
        name: dataSliceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSliceIndividualResponse'
          description: Data slice was found.
      summary: Retrieve a Data Slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/dataSlices/{dataSliceId}/sliceSizes/:
    get:
      description: Returns the number of rows available after applying a data slice
        to the specified subset of the dataset.
      operationId: dataSlicesSliceSizes_list
      parameters:
      - description: The project ID.
        in: query
        name: projectId
        required: true
        schema:
          type: string
      - description: The source of data to use to calculate the size.
        in: query
        name: source
        required: true
        schema:
          enum:
          - backtest_0
          - backtest_0_training
          - backtest_1
          - backtest_10
          - backtest_10_training
          - backtest_11
          - backtest_11_training
          - backtest_12
          - backtest_12_training
          - backtest_13
          - backtest_13_training
          - backtest_14
          - backtest_14_training
          - backtest_15
          - backtest_15_training
          - backtest_16
          - backtest_16_training
          - backtest_17
          - backtest_17_training
          - backtest_18
          - backtest_18_training
          - backtest_19
          - backtest_19_training
          - backtest_1_training
          - backtest_2
          - backtest_20
          - backtest_20_training
          - backtest_2_training
          - backtest_3
          - backtest_3_training
          - backtest_4
          - backtest_4_training
          - backtest_5
          - backtest_5_training
          - backtest_6
          - backtest_6_training
          - backtest_7
          - backtest_7_training
          - backtest_8
          - backtest_8_training
          - backtest_9
          - backtest_9_training
          - crossValidation
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
      - description: The external dataset ID to use when calculating the size of a
          slice. Use this parameter only when the source is 'externalTestSet'.
        in: query
        name: externalDatasetId
        required: false
        schema:
          nullable: true
          type: string
      - description: The model ID whose training dataset should be sliced. Use this
          parameter only when the source is 'training'.
        in: query
        name: modelId
        required: false
        schema:
          nullable: true
          type: string
      - description: ID of the data slice.
        in: path
        name: dataSliceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSliceRetrieveSubsetSizeResponse'
          description: The subset slice size was retrieved.
        '204':
          description: No slice size exists.
        '403':
          description: Unathorized access to resource.
      summary: Returns the number of rows available after applying a data slice to
        the specified subset of the dataset.
      tags:
      - insights
      x-versionadded: v2.31
    post:
      description: Compute the number of rows available after applying a data slice
        to the specified subset of the dataset.
      operationId: dataSlicesSliceSizes_create
      parameters:
      - description: ID of the data slice.
        in: path
        name: dataSliceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSliceComputeSubsetSizeRequest'
      responses:
        '202':
          description: The requested data slices have been successfully validated.
      summary: Compute the number of rows available after applying a data slice to
        the specified subset of the dataset.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/datasets/:
    get:
      description: List all datasets accessible by the user.
      operationId: datasets_list
      parameters:
      - description: If specified, only dataset versions that have the specified category
          will be included in the results. Categories identify the intended use of
          the dataset.
        in: query
        name: category
        required: false
        schema:
          enum:
          - TRAINING
          - PREDICTION
          type: string
      - description: Sorting order which will be applied to catalog list.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - created
          - -created
          type: string
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Whether datasets that failed during import should be excluded
          from the results. If True invalid datasets will be excluded.
        in: query
        name: filterFailed
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: If specified will only return datasets that are associated with
          specified dataset versions. Cannot be used as the same time with experiment_container_ids.
        in: query
        name: datasetVersionIds
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 20
            type: array
        x-versionadded: v2.21
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetListResponse'
          description: A paginated list of datasets
      summary: List datasets
      tags:
      - ai_catalog
      x-versionadded: v2.18
    patch:
      description: Execute the specified bulk action on multiple datasets.
      operationId: datasets_patchMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDatasetAction'
      responses:
        '204':
          description: Successfully executed
        '409':
          description: Cannot delete a dataset that has refresh jobs.
      summary: Execute bulk dataset action
      tags:
      - ai_catalog
      x-versionadded: v2.21
  /api/v2/datasets/fromDataEngineWorkspaceState/:
    post:
      description: Create a dataset from a Data Engine workspace state.
      operationId: datasetsFromDataEngineWorkspaceState_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetCreateFromWorkspaceState'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetDataEngineResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '410':
          description: Specified query output was already deleted.
      summary: Create dataset from Data Engine workspace
      tags:
      - ai_catalog
      x-versionadded: v2.21
  /api/v2/datasets/fromDataSource/:
    post:
      description: Create a Dataset Item from a data source.
      operationId: datasetsFromDataSource_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Datasource'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create dataset from data source
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/fromFile/:
    post:
      description: Create a dataset from a file.
      operationId: datasetsFromFile_create
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DatasetFromFile'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: The request cannot be processed. The request did not contain
            file contents.
      summary: Create dataset from file
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/fromHDFS/:
    post:
      description: Create a Dataset Item from an HDFS URL.
      operationId: datasetsFromHDFS_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hdfs'
      responses:
        '200':
          description: ''
      summary: Create dataset from HDFS URL
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/fromRecipe/:
    post:
      description: Create a dataset item and version from a recipe.During publishing,
        an immutable copy of the recipe is created, as well as a copy of the recipe's
        data source.
      operationId: datasetsFromRecipe_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFromRecipe'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create dataset from recipe.
      tags:
      - ai_catalog
      x-versionadded: v2.33
  /api/v2/datasets/fromURL/:
    post:
      description: Create a Dataset Item from a URL.
      operationId: datasetsFromURL_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Url'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create dataset from URL
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/:
    delete:
      description: Marks the dataset with the given ID as deleted.
      operationId: datasets_delete
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
        '409':
          description: Cannot delete a dataset that has refresh jobs.
      summary: Delete dataset
      tags:
      - ai_catalog
      x-versionadded: v2.19
    get:
      description: Retrieves the details of the dataset with given ID.
      operationId: datasets_retrieve
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullDatasetDetailsResponse'
          description: The dataset details
      summary: Get dataset details
      tags:
      - ai_catalog
      x-versionadded: v2.18
    patch:
      description: Modifies the specified dataset.
      operationId: datasets_patch
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchDataset'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicDatasetDetailsResponse'
          description: Dataset successfully modified
        '422':
          description: The categories are not applicable to the dataset.
      summary: Modify dataset
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/accessControl/:
    get:
      description: List the users and their associated roles for the specified dataset.
      operationId: datasetsAccessControl_list
      parameters:
      - description: Only return the access control information for a user with this
          user ID.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: Only return the access control information for a user with this
          username.
        in: query
        name: username
        required: false
        schema:
          type: string
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetAccessControlListResponse'
          description: A paginated list of user permissions
      summary: List dataset access
      tags:
      - ai_catalog
      x-versionadded: v2.18
    patch:
      description: Grant access to the dataset at the specified role level, or remove
        access to the dataset.
      operationId: datasetsAccessControl_patchMany
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetAccessSet'
      responses:
        '204':
          description: Successfully modified
        '409':
          description: Duplicate entry for a user in permission list or the request
            would leave the dataset without an owner.
      summary: Modify dataset access
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/allFeaturesDetails/:
    get:
      description: Return detailed information on all the features and transforms
        for this dataset.If the Dataset Item has attribute snapshot = True, all optional
        fields also appear
      operationId: datasetsAllFeaturesDetails_list
      parameters:
      - description: At most this many results are returned. The default may change
          and a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 0
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: How the features should be ordered.
        in: query
        name: orderBy
        required: true
        schema:
          default: name
          enum:
          - featureType
          - name
          - id
          - unique
          - missing
          - stddev
          - mean
          - median
          - min
          - max
          - -featureType
          - -name
          - -id
          - -unique
          - -missing
          - -stddev
          - -mean
          - -median
          - -min
          - -max
          type: string
      - description: Include histogram plot data in the response.
        in: query
        name: includePlot
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: A value to search for in the feature name. The search is case
          insensitive. If no value is provided, an empty string is used, or the string
          contains only whitespace, no filtering occurs.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
        x-versionadded: v2.33
      - description: 'ID of a featurelist. If specified, only returns features that
          are present in the specified featurelist. '
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
        x-versionadded: v2.33
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturesListResponse'
          description: A paginated list of feature info
      summary: Get dataset features
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/deleted/:
    patch:
      description: Recover the dataset item with given datasetId from `deleted`.
      operationId: datasetsDeleted_patchMany
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetDeleted'
      responses:
        '200':
          description: 'Item was not deleted: nothing to recover.'
        '204':
          description: Successfully recovered
      summary: Recover deleted dataset
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/documentsDataQualityLog/:
    get:
      description: Retrieve the documents data quality log content and log length
        as JSON.
      operationId: datasetsDocumentsDataQualityLog_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The ID of the dataset
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentsDataQualityLogLinesResponse'
          description: Paginated list of lines of the documents data quality log.
        '404':
          description: Documents data quality assessment log not available.
      summary: Retrieve the documents data quality log content and log length as JSON.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/datasets/{datasetId}/documentsDataQualityLog/file/:
    get:
      description: Retrieve a text file containing the documents data quality log.
      operationId: datasetsDocumentsDataQualityLogFile_list
      parameters:
      - description: The ID of the dataset
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the data quality log.
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data.
              schema:
                enum:
                - text/plain
                type: string
        '404':
          description: The data quality assessment log is not available.
      summary: Retrieve a text file containing the documents data quality log.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/datasets/{datasetId}/featureHistograms/{featureName}/:
    get:
      description: Get histogram chart data for a specific feature in the specified
        dataset.
      operationId: datasetsFeatureHistograms_retrieve
      parameters:
      - description: Maximum number of bins in the returned plot.
        in: query
        name: binLimit
        required: true
        schema:
          default: 60
          maximum: 60
          minimum: 1
          type: integer
      - description: Only required for the Summarized categorical feature. Name of
          the top 50 key for which plot to be retrieved.
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: The ID of the dataset entry to retrieve.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The name of the feature.
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeatureHistogramResponse'
          description: The feature histogram
      summary: Get dataset feature histogram
      tags:
      - ai_catalog
      x-versionadded: v2.20
  /api/v2/datasets/{datasetId}/featureTransforms/:
    get:
      description: Retrieves the transforms of the dataset with given ID.
      operationId: datasetsFeatureTransforms_list
      parameters:
      - description: At most this many results are returned. The default may change
          and a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetTransformListResponse'
          description: A paginated list of feature transforms
        '410':
          description: Dataset deleted.
      summary: List dataset feature transforms
      tags:
      - ai_catalog
      x-versionadded: v2.18
    post:
      description: Create a new feature by changing the type of an existing one.
      operationId: datasetsFeatureTransforms_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureTransform'
      responses:
        '202':
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '409':
          description: Feature name already exists.
        '410':
          description: Dataset deleted.
        '422':
          description: In case of an invalid transformation or when dataset does not
            have profile data or sample files available.
      summary: Create dataset feature transform
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/featureTransforms/{featureName}/:
    get:
      description: Retrieve the specified feature with descriptive information.
      operationId: datasetsFeatureTransforms_retrieve
      parameters:
      - description: The dataset to select feature from.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The name of the feature. Note that DataRobot renames some features,
          so the feature name may not be the one from your original data. Non-ascii
          features names should be utf-8-encoded (before URL-quoting).
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetTransformResponse'
          description: The feature transform
        '410':
          description: Dataset deleted.
      summary: Get dataset feature transform
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/featurelists/:
    get:
      description: Retrieves the featurelists of the dataset with given ID and the
        latest dataset version.
      operationId: datasetsFeaturelists_list
      parameters:
      - description: At most this many results are returned. The default may change
          and a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 0
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: How the feature lists should be ordered.
        in: query
        name: orderBy
        required: true
        schema:
          default: name
          enum:
          - name
          - description
          - featuresNumber
          - creationDate
          - userCreated
          - -name
          - -description
          - -featuresNumber
          - -creationDate
          - -userCreated
          type: string
      - description: A value to search for in the featurelist name. The search is
          case insensitive. If no value is provided, an empty string is used, or the
          string contains only whitespace, no filtering occurs.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
        x-versionadded: v2.33
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturelistListResponse'
          description: A paginated list of featurelists
      summary: Retrieve dataset featurelists
      tags:
      - ai_catalog
      x-versionadded: v2.18
    post:
      description: Create featurelist for specified dataset.
      operationId: datasetsFeaturelists_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureListCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturelistResponse'
          description: Successfully created
        '409':
          description: Feature list with specified name already exists
        '422':
          description: One or more of the specified features does not exist in the
            dataset
      summary: Create dataset featurelist
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/featurelists/{featurelistId}/:
    delete:
      description: Deletes the indicated featurelist of the dataset with given ID.
      operationId: datasetsFeaturelists_delete
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the featurelist.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
      summary: Delete dataset featurelist
      tags:
      - ai_catalog
      x-versionadded: v2.19
    get:
      description: Retrieves the specified featurelist of the dataset with given ID
        and the latest dataset version.
      operationId: datasetsFeaturelists_retrieve
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the featurelist.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturelistResponse'
          description: The featurelist
      summary: Get dataset featurelist
      tags:
      - ai_catalog
      x-versionadded: v2.18
    patch:
      description: Modifies the indicated featurelist of the dataset with given ID.
      operationId: datasetsFeaturelists_patch
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the featurelist.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureListModify'
      responses:
        '200':
          description: Successfully modified
      summary: Update dataset featurelist
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/file/:
    get:
      description: Retrieve all the originally uploaded data, in CSV form.
      operationId: datasetsFile_list
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.apache.parquet:
              schema:
                format: binary
                type: string
            text/csv:
              schema:
                type: string
          description: The original dataset data
        '409':
          description: Ingest info is missing for dataset version.
        '422':
          description: Dataset cannot be downloaded. Possible reasons include "dataPersisted"
            being false for the dataset, the dataset not being a snapshot, and this
            dataset is too big to be downloaded (maximum download size depends on
            a config of your installation).
      summary: Retrieve original dataset data
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/imagesDataQualityLog/:
    get:
      description: Retrieve the images data quality log content and log length as
        JSON
      operationId: datasetsImagesDataQualityLog_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The ID of the dataset
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImagesDataQualityLogLinesResponse'
          description: Paginated list of lines of the image data quality log
      summary: Retrieve the images data quality log content and log length as JSON
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/datasets/{datasetId}/imagesDataQualityLog/file/:
    get:
      description: Retrieve a text file containing the images data quality log.
      operationId: datasetsImagesDataQualityLogFile_list
      parameters:
      - description: The ID of the dataset
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the images data quality log.
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - text/plain
                type: string
      summary: Retrieve a text file containing the images data quality log.
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/datasets/{datasetId}/permissions/:
    get:
      description: Describe what permissions current user has for given dataset.
      operationId: datasetsPermissions_list
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetDescribePermissionsResponse'
          description: The dataset permissions
      summary: Describe dataset permissions
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/projects/:
    get:
      description: Retrieves a dataset's projects by dataset ID.
      operationId: datasetsProjects_list
      parameters:
      - description: Only this many items are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: Skip this many items.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetProjectListResponse'
          description: A paginated list of projects
      summary: Get dataset projects
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/refreshJobs/:
    get:
      description: Paginated list of scheduled jobs descriptions for a specific dataset
        with given dataset ID, sorted by time of the last update.
      operationId: datasetsRefreshJobs_list
      parameters:
      - description: Only this many items are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: Skip this many items.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRefreshJobsListResponse'
          description: List of a dataset's scheduled job information retrieved successfully.
      summary: Information about scheduled jobs for given dataset.
      tags:
      - ai_catalog
      x-versionadded: v2.20
    post:
      description: '

        Create a dataset refresh job that will automatically create dataset snapshots
        on a schedule.


        Optionally if the limit of enabled jobs per user is reached the following
        metadata will be added

        to the default error response payload:


        - **datasetsWithJob** (*array*) - The list of datasets IDs that have at least
        one enabled job.

        - **errorType** (*string*) - (New in version v2.21) The type of error that
        happened, possible values include (but are not limited to): ``Generic Limit
        Reached``, ``Max Job Limit Reached for Dataset``, and ``Max Job Limit Reached
        for User``.'
      operationId: datasetsRefreshJobs_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetRefreshJobCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRefreshJobResponse'
          description: Dataset refresh job created.
        '409':
          description: The maximum number of enabled jobs is reached.
        '422':
          description: Refresh job could not be created. Possible reasons include,
            the job does not belong to the given dataset, credential ID required when
            Kerberos authentication enabled, or the schedule is not valid or cannot
            be understood.
      summary: Schedule dataset refresh
      tags:
      - ai_catalog
      x-versionadded: v2.20
  /api/v2/datasets/{datasetId}/refreshJobs/{jobId}/:
    delete:
      description: Deletes an existing dataset refresh job.
      operationId: datasetsRefreshJobs_delete
      parameters:
      - description: The dataset associated with the scheduled refresh job.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: ID of the user scheduled dataset refresh job.
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Scheduled Job deleted.
        '422':
          description: Invalid job ID or dataset ID provided.
      summary: Deletes an existing dataset refresh job
      tags:
      - ai_catalog
      x-versionadded: v2.20
    get:
      description: Gets configuration of a user scheduled dataset refresh job by job
        ID.
      operationId: datasetsRefreshJobs_retrieve
      parameters:
      - description: The dataset associated with the scheduled refresh job.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: ID of the user scheduled dataset refresh job.
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRefreshJobResponse'
          description: Job information retrieved successfully.
      summary: Gets configuration of a user scheduled dataset refresh job by job ID
      tags:
      - ai_catalog
      x-versionadded: v2.20
    patch:
      description: '

        Update a dataset refresh job.


        Optionally if the limit of enabled jobs per user is reached the following
        metadata will be added

        to the default error response payload:


        - **datasetsWithJob** (*array*) - The list of datasets IDs that have at least
        one enabled job.

        - **errorType** (*string*) - (New in version v2.21) The type of error that
        happened, possible values include (but are not limited to): ``Generic Limit
        Reached``, ``Max Job Limit Reached for Dataset``, and ``Max Job Limit Reached
        for User``.'
      operationId: datasetsRefreshJobs_patch
      parameters:
      - description: The dataset associated with the scheduled refresh job.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: ID of the user scheduled dataset refresh job.
        in: path
        name: jobId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetRefreshJobUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRefreshJobResponse'
          description: Scheduled Job configuration updated.
        '409':
          description: The maximum number of enabled jobs is reached.
        '422':
          description: Refresh job could not be updated. Possible reasons include,
            the job does not belong to the given dataset, credential ID required when
            Kerberos authentication enabled, or the schedule is not valid or cannot
            be understood.
      summary: Update a dataset refresh job
      tags:
      - ai_catalog
      x-versionadded: v2.20
  /api/v2/datasets/{datasetId}/refreshJobs/{jobId}/executionResults/:
    get:
      description: Paginated list of execution results for refresh job with the given
        ID and dataset with the given ID, sorted from newest to oldest.
      operationId: datasetsRefreshJobsExecutionResults_list
      parameters:
      - description: Maximum number of results returned. The default may change and
          a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 20
          maximum: 100
          minimum: 1
          type: integer
      - description: Number of results that will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The dataset associated with the scheduled refresh job.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: ID of the user scheduled dataset refresh job.
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRefreshJobRetrieveExecutionResultsResponse'
          description: Paginated list of dataset refresh job results, sorted from
            latest to oldest.
      summary: Results of dataset refresh job.
      tags:
      - ai_catalog
      x-versionadded: v2.20
  /api/v2/datasets/{datasetId}/relationships/:
    get:
      description: Retrieve a list of the dataset relationships for a specific dataset.
      operationId: datasetsRelationships_list
      parameters:
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Providing `linkedDatasetId` will filter such that only relationships
          between `datasetId` (from the path) and `linkedDatasetId` will be returned.
        in: query
        name: linkedDatasetId
        required: false
        schema:
          type: string
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRelationshipListResponse'
          description: A paginated list of dataset relationships
        '410':
          description: Dataset deleted
      summary: 'List related datasets '
      tags:
      - ai_catalog
      x-versionadded: v2.19
    post:
      description: Create a dataset relationship.
      operationId: datasetsRelationships_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetRelationshipCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRelationshipResponse'
          description: Successfully created
        '409':
          description: Relationship already exists.
        '410':
          description: Dataset deleted.
        '422':
          description: Missing or unrecognized fields.
      summary: Create dataset relationship.
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/relationships/{datasetRelationshipId}/:
    delete:
      description: Delete a dataset relationship.
      operationId: datasetsRelationships_delete
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset relationship to delete.
        in: path
        name: datasetRelationshipId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
        '410':
          description: Dataset deleted.
      summary: Delete dataset relationship.
      tags:
      - ai_catalog
      x-versionadded: v2.19
    patch:
      description: Update a dataset relationship.
      operationId: datasetsRelationships_patch
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset relationship to delete.
        in: path
        name: datasetRelationshipId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetRelationshipUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetRelationshipResponse'
          description: Successfully updated
        '409':
          description: Relationship already exists
        '410':
          description: Dataset deleted
        '422':
          description: 'Bad payload: missing or unrecognized fields'
      summary: Update dataset relationship.
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this dataset and their roles.
      operationId: datasetsSharedRoles_list
      parameters:
      - description: Only return the access control information for a organization,
          group or user with this ID.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Only return the access control information for a organization,
          group or user with this name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: It describes the recipient type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRolesListResponse'
          description: A paginated list of user permissions
      summary: List dataset shared roles
      tags:
      - ai_catalog
      x-versionadded: v2.22
    patch:
      description: Grant access, remove access or update roles for organizations,
        groups or users on this dataset. Up to 100 roles may be set per array in a
        single request.
      operationId: datasetsSharedRoles_patchMany
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetSharedRoles'
      responses:
        '204':
          description: Successfully modified
        '409':
          description: Duplicate entry for the org/group/user in permission listor
            the request would leave the dataset without an owner.
        '422':
          description: Request is unprocessable. For example, `name` is stated for
            not user recipient.
      summary: Modify dataset shared roles
      tags:
      - ai_catalog
      x-versionadded: v2.22
  /api/v2/datasets/{datasetId}/versions/:
    get:
      description: List all versions associated with given datasetId and which match
        the specified query parameters.
      operationId: datasetsVersions_list
      parameters:
      - description: If specified, only dataset versions that have the specified category
          will be included in the results. Categories identify the intended use of
          the dataset.
        in: query
        name: category
        required: false
        schema:
          enum:
          - TRAINING
          - PREDICTION
          type: string
      - description: Sorting order which will be applied to catalog list.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - created
          - -created
          type: string
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Whether datasets that failed during import should be excluded
          from the results. If True invalid datasets will be excluded.
        in: query
        name: filterFailed
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetListResponse'
          description: A paginated list of dataset versions
      summary: List dataset versions
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/fromDataEngineWorkspaceState/:
    post:
      description: Create a new dataset version for a specified dataset from a Data
        Engine workspace state. The new dataset version should have the same schema
        as the specified dataset.
      operationId: datasetsVersionsFromDataEngineWorkspaceState_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetCreateFromWorkspaceState'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetDataEngineResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '410':
          description: Specified workspace was already deleted.
        '422':
          description: Type of new dataset version is incompatible with specified
            dataset.
      summary: Create dataset version from Data Engine workspace
      tags:
      - ai_catalog
      x-versionadded: v2.21
  /api/v2/datasets/{datasetId}/versions/fromDataSource/:
    post:
      description: Create a new version for the specified dataset from specified Data
        Source. The dataset must have been created from a compatible data source originally.
      operationId: datasetsVersionsFromDataSource_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Datasource'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create dataset version from Data Source
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/versions/fromFile/:
    post:
      description: Create a new version for the specified dataset from a file.
      operationId: datasetsVersionsFromFile_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetFromFile'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create dataset version from file
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/fromHDFS/:
    post:
      description: Create a new version for the specified dataset from a HDFS URL.
        The dataset must have been created from the same HDFS URL originally.
      operationId: datasetsVersionsFromHDFS_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hdfs'
      responses:
        '200':
          description: ''
      summary: Create dataset version from HDFS URL
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/versions/fromLatestVersion/:
    post:
      description: "Create a new version of the specified dataset from the latest\
        \ dataset version. This will reuse the same source of the data that was previously\
        \ used. Not supported for datasets that were previously loaded from an uploaded\
        \ file. If the dataset is currently a remote dataset, it will be converted\
        \ to a snapshot dataset.\nNOTE: \nif the current version uses a Data Source,\
        \ the `user` and `password` must be specified so the data can be accessed."
      operationId: datasetsVersionsFromLatestVersion_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FromLatest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '409':
          description: The latest version of the dataset is in an errored state.
      summary: Create dataset version from data source
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/fromURL/:
    post:
      description: Create a new version for the specified dataset from specified URL.
        The dataset must have been created from the same URL originally.
      operationId: datasetsVersionsFromURL_create
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Url'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create dataset version from URL
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/:
    delete:
      description: Marks the dataset version with the given ID as deleted.
      operationId: datasetsVersions_delete
      parameters:
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
      summary: Delete dataset version
      tags:
      - ai_catalog
      x-versionadded: v2.19
    get:
      description: Retrieves the details of the dataset with given ID and version
        ID.
      operationId: datasetsVersions_retrieve
      parameters:
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullDatasetDetailsResponse'
          description: The dataset details
      summary: Get dataset details by version
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/allFeaturesDetails/:
    get:
      description: Return detailed information on all the features and transforms
        for this dataset.If the Dataset Item has attribute snapshot = True, all optional
        fields also appear
      operationId: datasetsVersionsAllFeaturesDetails_list
      parameters:
      - description: At most this many results are returned. The default may change
          and a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 0
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: How the features should be ordered.
        in: query
        name: orderBy
        required: true
        schema:
          default: name
          enum:
          - featureType
          - name
          - id
          - unique
          - missing
          - stddev
          - mean
          - median
          - min
          - max
          - -featureType
          - -name
          - -id
          - -unique
          - -missing
          - -stddev
          - -mean
          - -median
          - -min
          - -max
          type: string
      - description: Include histogram plot data in the response.
        in: query
        name: includePlot
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: A value to search for in the feature name. The search is case
          insensitive. If no value is provided, an empty string is used, or the string
          contains only whitespace, no filtering occurs.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
        x-versionadded: v2.33
      - description: 'ID of a featurelist. If specified, only returns features that
          are present in the specified featurelist. '
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
        x-versionadded: v2.33
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturesListResponse'
          description: A paginated list of feature info
      summary: Get dataset features
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/deleted/:
    patch:
      description: Recover the dataset version item with given datasetId and datasetVersionId
        from `deleted`.
      operationId: datasetsVersionsDeleted_patchMany
      parameters:
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetDeleted'
      responses:
        '200':
          description: 'The item was not deleted: nothing to recover.'
        '204':
          description: Successfully recovered
      summary: Recover deleted dataset version
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/documentsDataQualityLog/:
    get:
      description: Retrieve the documents data quality log content and log length
        as JSON.
      operationId: datasetsVersionsDocumentsDataQualityLog_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentsDataQualityLogLinesResponse'
          description: Paginated list of lines of the documents data quality log.
        '404':
          description: Documents data quality assessment log not available.
      summary: Retrieve the documents data quality log content and log length as JSON.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/documentsDataQualityLog/file/:
    get:
      description: Retrieve a text file containing the documents data quality log.
      operationId: datasetsVersionsDocumentsDataQualityLogFile_list
      parameters:
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the data quality log.
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data.
              schema:
                enum:
                - text/plain
                type: string
        '404':
          description: The data quality assessment log is not available.
      summary: Retrieve a text file containing the documents data quality log.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/featureHistograms/{featureName}/:
    get:
      description: Get histogram chart data for a specific feature in the specified
        dataset.
      operationId: datasetsVersionsFeatureHistograms_retrieve
      parameters:
      - description: Maximum number of bins in the returned plot.
        in: query
        name: binLimit
        required: true
        schema:
          default: 60
          maximum: 60
          minimum: 1
          type: integer
      - description: Only required for the Summarized categorical feature. Name of
          the top 50 key for which plot to be retrieved.
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: The ID of the dataset entry to retrieve.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version to retrieve.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      - description: The name of the feature.
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeatureHistogramResponse'
          description: The feature histogram
      summary: Get dataset feature histogram
      tags:
      - ai_catalog
      x-versionadded: v2.20
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/featurelists/:
    get:
      description: Retrieves the featurelists of the dataset with given ID and the
        latest dataset version.
      operationId: datasetsVersionsFeaturelists_list
      parameters:
      - description: At most this many results are returned. The default may change
          and a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 0
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: How the feature lists should be ordered.
        in: query
        name: orderBy
        required: true
        schema:
          default: name
          enum:
          - name
          - description
          - featuresNumber
          - creationDate
          - userCreated
          - -name
          - -description
          - -featuresNumber
          - -creationDate
          - -userCreated
          type: string
      - description: A value to search for in the featurelist name. The search is
          case insensitive. If no value is provided, an empty string is used, or the
          string contains only whitespace, no filtering occurs.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
        x-versionadded: v2.33
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturelistListResponse'
          description: A paginated list of featurelists
      summary: Retrieve dataset featurelists
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/featurelists/{featurelistId}/:
    get:
      description: Retrieves the specified featurelist of the dataset with given ID
        and the latest dataset version.
      operationId: datasetsVersionsFeaturelists_retrieve
      parameters:
      - description: The ID of the dataset to retrieve featurelist for.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version to retrieve featurelists for.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      - description: The ID of the featurelist.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetFeaturelistResponse'
          description: The featurelist
      summary: Get dataset featurelist
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/file/:
    get:
      description: Retrieve all the originally uploaded data, in CSV form.
      operationId: datasetsVersionsFile_list
      parameters:
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.apache.parquet:
              schema:
                format: binary
                type: string
            text/csv:
              schema:
                type: string
          description: The original dataset data
        '409':
          description: Ingest info is missing for dataset version.
        '422':
          description: Dataset version cannot be downloaded. Possible reasons include
            dataPersisted being false for the dataset, the dataset not being a snapshot,
            and this dataset version is too big to be downloaded (maximum download
            size depends on a config of your installation).
      summary: Retrieve original dataset data
      tags:
      - ai_catalog
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/fromVersion/:
    post:
      description: 'Create a new version of the specified dataset from the specified
        dataset version. This will reuse the same source of the data that was previously
        used. Not supported for datasets that were previously loaded from an uploaded
        file. If the dataset is currently a remote dataset, it will be converted to
        a snapshot dataset.

        NOTE:

        If the specified version uses a Data Source, the `user` and `password` must
        be specified so the data can be accessed.'
      operationId: datasetsVersionsFromVersion_create
      parameters:
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FromSpecific'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '409':
          description: The dataset item's specified version is in an errored state.
      summary: Create dataset version from previous version
      tags:
      - ai_catalog
      x-versionadded: v2.20
  /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/projects/:
    get:
      description: Retrieves a dataset's projects for the specified catalog dataset
        and dataset version id.
      operationId: datasetsVersionsProjects_list
      parameters:
      - description: Only this many items are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: Skip this many items.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of the dataset entry.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The ID of the dataset version.
        in: path
        name: datasetVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDatasetVersionProjectsResponse'
          description: A paginated list of projects
      summary: Get dataset projects by version
      tags:
      - ai_catalog
      x-versionadded: v2.19
  /api/v2/deletedCustomJobs/:
    get:
      description: List deleted custom jobs.
      operationId: deletedCustomJobs_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobListResponse'
          description: List of deleted custom jobs.
        '403':
          description: Custom jobs are not enabled.
      summary: List deleted custom jobs.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the Custom Jobs Workshop.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_JOBS
      x-versionadded: v2.33
  /api/v2/deletedDeployments/:
    get:
      description: List deleted deployments.Only available as part of an enterprise
        (on-prem) installation. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
      operationId: deletedDeployments_list
      parameters:
      - description: The number of deleted deployments to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of deleted deployments to return.
        in: query
        name: limit
        required: true
        schema:
          default: 20
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedDeploymentListResponse'
          description: The deleted deployments
      summary: List deleted deployments
      tags:
      - deployments
      x-versionadded: v2.21
    patch:
      description: Permanently erase data for deleted deployments. Only available
        as part of an on-premise or private/hybrid cloud deployment. Requires a CAN_DELETE_APP_PROJECTS
        permission to execute.
      operationId: deletedDeployments_patchMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentPermanentDelete'
      responses:
        '202':
          description: Job submitted. See Location header.
          headers:
            Location:
              description: URL for tracking deployment permanently erase job status.
              schema:
                type: string
      summary: Erase deleted deployments
      tags:
      - deployments
      x-versionadded: v2.21
  /api/v2/deletedProjects/:
    get:
      description: Retrieve a list of soft-deleted projects matching search criteria
      operationId: deletedProjects_list
      parameters:
      - description: Project or dataset name to filter by
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: Creator ID to filter projects by
        in: query
        name: creator
        required: false
        schema:
          type: string
      - description: ID of organization that projects should belong to. Given project
          belongs to the organization the user who created the project is part of
          that organization.If there are no users in organization, then no projects
          will match the query.
        in: query
        name: organization
        required: false
        schema:
          type: string
      - description: ISO-8601 formatted date projects were deleted before
        in: query
        name: deletedBefore
        required: false
        schema:
          format: date-time
          type: string
      - description: ISO-8601 formatted date projects were deleted after
        in: query
        name: deletedAfter
        required: false
        schema:
          format: date-time
          type: string
      - description: Project ID to search
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 20
          maximum: 1000
          minimum: 1
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Order deleted projects by
        in: query
        name: orderBy
        required: false
        schema:
          default: deletedOn
          enum:
          - projectId
          - projectName
          - datasetName
          - deletedOn
          - deletedBy
          - creator
          - -projectId
          - -projectName
          - -datasetName
          - -deletedOn
          - -deletedBy
          - -creator
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedProjectListResponse'
          description: List of soft-deleted projects
      summary: Retrieve a list of soft-deleted projects
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/deletedProjects/{projectId}/:
    patch:
      description: Recover (undelete) soft-deleted project
      operationId: deletedProjects_patch
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectRecover'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectRecoverResponse'
          description: Recovery operation result description
      summary: Recover soft-deleted project
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/deletedProjectsCount/:
    get:
      description: Get current number of deleted projects matching search criteria.
        Value is limited by DELETED_PROJECTS_BATCH_LIMIT system setting. That means
        that the actual amount of deleted projects can be greater than the limit,
        but counting will stop when reaching it.
      operationId: deletedProjectsCount_list
      parameters:
      - description: Project or dataset name to filter by
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: Creator ID to filter projects by
        in: query
        name: creator
        required: false
        schema:
          type: string
      - description: ID of organization that projects should belong to. Given project
          belongs to the organization the user who created the project is part of
          that organization.If there are no users in organization, then no projects
          will match the query.
        in: query
        name: organization
        required: false
        schema:
          type: string
      - description: ISO-8601 formatted date projects were deleted before
        in: query
        name: deletedBefore
        required: false
        schema:
          format: date-time
          type: string
      - description: ISO-8601 formatted date projects were deleted after
        in: query
        name: deletedAfter
        required: false
        schema:
          format: date-time
          type: string
      - description: Project ID to search
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: Count deleted projects until specified value reached.
        in: query
        name: limit
        required: false
        schema:
          maximum: 1000
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedProjectCountResponse'
          description: Soft-deleted projects amount, current counting limit value
            and boolean flag to notify if an actual amount of soft-deleted projects
            in the system exceeds the limit value.
      summary: Count soft-deleted projects.
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/deployments/:
    get:
      description: List deployments a user can view.
      operationId: deployments_list
      parameters:
      - description: The number of deployments to skip. Defaults to 0.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of deployments (greater than zero, max 100) to return.
          Defaults to 20.
        in: query
        name: limit
        required: true
        schema:
          default: 20
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The order to sort the deployments.Defaults to order by deployment
          last prediction timestamp in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - label
          - -label
          - serviceHealth
          - -serviceHealth
          - modelHealth
          - -modelHealth
          - accuracyHealth
          - -accuracyHealth
          - recentPredictions
          - -recentPredictions
          - lastPredictionTimestamp
          - -lastPredictionTimestamp
          - currentModelDeployedTimestamp
          - -currentModelDeployedTimestamp
          - createdAtTimestamp
          - -createdAtTimestamp
          - importance
          - -importance
          - fairnessHealth
          - -fairnessHealth
          - customMetricsHealth
          - -customMetricsHealth
          - actualsTimelinessHealth
          - -actualsTimelinessHealth
          - predictionsTimelinessHealth
          - -predictionsTimelinessHealth
          type: string
        x-versionadded: v2.18
      - description: Case insensitive search against deployment's label and description.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          type: string
        x-versionadded: v2.18
      - description: Filters deployments by their service health status.
        in: query
        name: serviceHealth
        required: false
        schema:
          items:
            enum:
            - failing
            - not_started
            - passing
            - unavailable
            - unknown
            - warning
            type: string
          type: array
        x-versionadded: v2.20
      - description: Filters deployments by their model health status.
        in: query
        name: modelHealth
        required: false
        schema:
          items:
            enum:
            - failing
            - not_started
            - passing
            - unavailable
            - unknown
            - warning
            type: string
          type: array
        x-versionadded: v2.20
      - description: Filters deployments by their accuracy health status.
        in: query
        name: accuracyHealth
        required: false
        schema:
          items:
            enum:
            - failing
            - not_started
            - passing
            - unavailable
            - unknown
            - warning
            type: string
          type: array
        x-versionadded: v2.20
      - description: Filter deployments to only those that the authenticated user
          has the specified role for.
        in: query
        name: role
        required: false
        schema:
          enum:
          - OWNER
          - USER
          type: string
        x-versionadded: v2.20
      - description: Filters deployments by their status
        in: query
        name: status
        required: false
        schema:
          items:
            enum:
            - active
            - archived
            - errored
            - inactive
            - launching
            - replacingModel
            - stopping
            type: string
          type: array
        x-versionadded: v2.25
      - description: Filters deployments by their importance
        in: query
        name: importance
        required: false
        schema:
          items:
            enum:
            - CRITICAL
            - HIGH
            - MODERATE
            - LOW
            type: string
          type: array
        x-versionadded: v2.21
      - description: Only include deployments that have had a prediction request on
          or after the specified timestamp.
        in: query
        name: lastPredictionTimestampStart
        required: false
        schema:
          format: date-time
          type: string
        x-versionadded: v2.23
      - description: Only include deployments that have had a prediction request before
          the specified timestamp.
        in: query
        name: lastPredictionTimestampEnd
        required: false
        schema:
          format: date-time
          type: string
        x-versionadded: v2.23
      - description: only include deployments that have had more than the specified
          number of predictions per day on average over the past week.
        in: query
        name: predictionUsageDailyAvgGreaterThan
        required: false
        schema:
          minimum: 0
          type: integer
        x-versionadded: v2.23
      - description: Only include deployments that have had fewer than the specified
          number of predictions per day on average over the past week.
        in: query
        name: predictionUsageDailyAvgLessThan
        required: false
        schema:
          exclusiveMinimum: true
          minimum: 0
          type: integer
        x-versionadded: v2.23
      - description: Filter deployments to those whose default prediction server has
          the specified id.
        in: query
        name: defaultPredictionServerId
        required: false
        schema:
          items:
            type: string
          type: array
        x-versionadded: v2.23
      - description: Filter deployments based on the type of their current model's
          build environment type.
        in: query
        name: buildEnvironmentType
        required: false
        schema:
          items:
            enum:
            - DataRobot
            - Python
            - R
            - Java
            - Julia
            - Legacy
            - Other
            type: string
          type: array
        x-versionadded: v2.21
      - description: Filter deployments based on the type of their execution environment.
        in: query
        name: executionEnvironmentType
        required: false
        schema:
          items:
            enum:
            - datarobot
            - external
            type: string
          type: array
        x-versionadded: v2.20
      - description: Filter deployments based on prediction environment platform
        in: query
        name: predictionEnvironmentPlatform
        required: false
        schema:
          items:
            enum:
            - aws
            - gcp
            - azure
            - onPremise
            - datarobot
            - datarobotServerless
            - openShift
            - other
            - snowflake
            type: string
          type: array
        x-versionadded: v2.22
      - description: Filter deployments based if it is a decision flow
        in: query
        name: hasDecisionFlow
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter deployments to those created by the current user.
        in: query
        name: createdByMe
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.29
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentListResponse'
          description: The deployments
      summary: List deployments
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/deployments/fromLearningModel/:
    post:
      description: Create a deployment from a DataRobot model.
      operationId: deploymentsFromLearningModel_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentCreateFromLearningModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCreateResponse'
          description: Deployment successfully created.
        '403':
          description: User does not have permission to create a deployment.
        '409':
          description: User's organization has reached the maximum number of deployments.
        '422':
          description: Unable to process the deployment creation request.
      summary: Create deployment from DataRobot model
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/:
    delete:
      description: Delete a deployment.
      operationId: deployments_delete
      parameters:
      - description: Do not wait for management agent to delete the deployment first.
        in: query
        name: ignoreManagementAgent
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deployment successfully deleted.
        '422':
          description: Unable to process the request.
      summary: Delete deployment
      tags:
      - deployments
      x-versionadded: v2.17
    get:
      description: Retrieve a deployment.
      operationId: deployments_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentRetrieveResponse'
          description: The deployment
      summary: Retrieve deployment
      tags:
      - deployments
      x-versionadded: v2.17
    patch:
      description: Update a deployment's label and description.
      operationId: deployments_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentUpdate'
      responses:
        '204':
          description: Deployment successfully updated
      summary: Update deployment
      tags:
      - deployments
      x-versionadded: v2.19
  /api/v2/deployments/{deploymentId}/accuracy/:
    get:
      description: Retrieve accuracy metric for a certain time period.
      operationId: deploymentsAccuracy_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
        x-versionadded: v2.32
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: Comma separated list of target classes to filter out response
        in: query
        name: targetClasses
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.23
        x-versiondeprecated: v2.31
      - description: Target class to filter out results.
        in: query
        name: targetClass
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
        x-versionadded: v2.31
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccuracyResponse'
          description: Deployment accuracy metrics are retrieved.
      summary: Retrieve accuracy metric
      tags:
      - deployments
      x-versionadded: v2.18
  /api/v2/deployments/{deploymentId}/accuracyOverBatch/:
    get:
      description: Retrieve accuracy metric baseline, and metric value calculated
        for each batch.
      operationId: deploymentsAccuracyOverBatch_list
      parameters:
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: Accuracy metric being requested.
        in: query
        name: metric
        required: false
        schema:
          enum:
          - AUC
          - Accuracy
          - Balanced Accuracy
          - F1
          - FPR
          - FVE Binomial
          - FVE Gamma
          - FVE Poisson
          - FVE Tweedie
          - Gamma Deviance
          - Gini Norm
          - Kolmogorov-Smirnov
          - LogLoss
          - MAE
          - MAPE
          - MCC
          - NPV
          - PPV
          - Poisson Deviance
          - R Squared
          - RMSE
          - RMSLE
          - Rate@Top10%
          - Rate@Top5%
          - TNR
          - TPR
          - Tweedie Deviance
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccuracyOverBatchResponse'
          description: Retrieve accuracy metrics over batches for a deployment.
      summary: Accuracy over batch for a deployment.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/accuracyOverTime/:
    get:
      description: Retrieve accuracy metric baseline, and metric value calculated
        for each time bucket dividing a longer time period.
      operationId: deploymentsAccuracyOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The time duration of a bucket. Needs to be multiple of one hour.
          Can not be longer than the total length of the period. If not set, a default
          value will be calculated based on the start and end time.
        in: query
        name: bucketSize
        required: false
        schema:
          format: duration
          type: string
      - description: The id of the models for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
      - description: Name of the metric.
        in: query
        name: metric
        required: false
        schema:
          enum:
          - AUC
          - Accuracy
          - Balanced Accuracy
          - F1
          - FPR
          - FVE Binomial
          - FVE Gamma
          - FVE Multinomial
          - FVE Poisson
          - FVE Tweedie
          - Gamma Deviance
          - Gini Norm
          - Kolmogorov-Smirnov
          - LogLoss
          - MAD
          - MAE
          - MAPE
          - MCC
          - NPV
          - PPV
          - Poisson Deviance
          - R Squared
          - RMSE
          - RMSLE
          - Rate@Top10%
          - Rate@Top5%
          - TNR
          - TPR
          - Tweedie Deviance
          type: string
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: List of target classes to filter out response
        in: query
        name: targetClasses
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: '2.23'
        x-versiondeprecated: v2.31
      - description: Target class to filter out results.
        in: query
        name: targetClass
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
        x-versionadded: v2.31
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccuracyOverTimeResponse'
          description: Accuracy over time.
      summary: Retrieve accuracy over time.
      tags:
      - deployments
      x-versionadded: v2.18
  /api/v2/deployments/{deploymentId}/actuals/fromDataset/:
    post:
      description: Submit actuals values for processing using catalog item. Submission
        of actuals is limited to 10,000,000 actuals per hour. For time series deployments,
        total actuals = number of actuals * number of forecast distances. For example,
        submitting 10 actuals for a deployment with 50 forecast distances = 500 total
        actuals. For multiclass deployments, a similar calculation is made where total
        actuals = number of actuals * number of classes. For example, submitting 10
        actuals for a deployment with 20 classes = 200 actuals.
      operationId: deploymentsActualsFromDataset_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentDatasetCreate'
      responses:
        '202':
          description: Submitted successfully. See Location header.
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: Unable to process the Actuals submission request.
        '429':
          description: The number of actuals uploaded this hour exceeds the limit
            of 10000000 rows.
      summary: Submit actuals values from AI Catalog
      tags:
      - deployments
      x-versionadded: v2.24
  /api/v2/deployments/{deploymentId}/actuals/fromJSON/:
    post:
      description: Submit actuals values for processing. Values are not processed
        immediately and may take some time to propagate through deployment systems.
        Submission of actuals is limited to 10,000,000 actuals per hour. For time
        series deployments, total actuals = number of actuals * number of forecast
        distances. For example, submitting 10 actuals for a deployment with 50 forecast
        distances = 500 total actuals. For multiclass deployments, a similar calculation
        is made where total actuals = number of actuals * number of classes. For example,
        submitting 10 actuals for a deployment with 20 classes = 200 actuals.
      operationId: deploymentsActualsFromJSON_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentActuals'
      responses:
        '202':
          description: Submitted successfully. See Location header.
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: Unable to process the Actuals submission request.
        '429':
          description: The number of actuals uploaded this hour exceeds the limit
            of 10000000 rows.
      summary: Submit actuals values
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/actualsDataExports/:
    get:
      description: Retrieve a list of asynchronous actuals data exports.
      operationId: deploymentsActualsDataExports_list
      parameters:
      - description: Offset this number of objects to retrieve.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this number of objects to retrieve.
        in: query
        name: limit
        required: false
        schema:
          default: 20
          maximum: 100
          minimum: 1
          type: integer
      - description: An actuals data export state overwrite value.
        in: query
        name: status
        required: false
        schema:
          default: null
          enum:
          - CANCELLED
          - CREATED
          - FAILED
          - SCHEDULED
          - SUCCEEDED
          nullable: true
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActualsExportListResponse'
          description: Success
        '403':
          description: User does not have permission to access a particular deployment.
        '404':
          description: Resource not found.
        '422':
          description: Unable to process the actuals data exports list retrieval due
            to invalid parameter values.
      summary: Retrieve a list of asynchronous actuals data exports.
      tags:
      - deployments
      x-versionadded: v2.33
    post:
      description: Create a deployment actuals data export.
      operationId: deploymentsActualsDataExports_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActualsExportCreatePayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActualsDataExportEntity'
          description: Actuals data export successfully created.
        '403':
          description: User does not have permission to create an actuals data export.
        '404':
          description: Resource not found.
        '422':
          description: Unable to process the actuals data export creation request.
      summary: Create a deployment actuals data export.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/:
    delete:
      description: Delete an actual export.
      operationId: deploymentsActualsDataExports_delete
      parameters:
      - description: ID of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the actuals data export job.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: An actual export was successfully deleted.
        '403':
          description: User does not have permission to delete an actual export.
        '404':
          description: Actual export was not found.
      summary: Delete an actual export.
      tags:
      - deployments
      x-versionadded: v2.33
    get:
      description: Retrieve a single actuals data export.
      operationId: deploymentsActualsDataExports_retrieve
      parameters:
      - description: ID of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the actuals data export job.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActualsDataExportEntity'
          description: A given actuals data export user can view is retrieved.
        '403':
          description: User does not have permission to access a particular deployment
            or actuals data export.
        '404':
          description: Resource not found.
      summary: Retrieve a single actuals data export.
      tags:
      - deployments
      x-versionadded: v2.33
    patch:
      description: Update actuals data export.
      operationId: deploymentsActualsDataExports_patch
      parameters:
      - description: ID of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the actuals data export job.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActualsDataUpdate'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActualsDataExportEntity'
          description: Actuals data export updated.
        '403':
          description: User does not have permission to update the actuals data export.
        '404':
          description: Requested resource does not exist or the user does not have
            permission to view it.
        '422':
          description: Unable to process the actuals data export update.
      summary: Update actuals data export.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/batchServiceStats/:
    get:
      description: Retrieve all deployment service health metrics over a set of batches.
      operationId: deploymentsBatchServiceStats_list
      parameters:
      - description: Quantile for executionTime metric.
        in: query
        name: executionTimeQuantile
        required: false
        schema:
          default: 0.5
          maximum: 1
          minimum: 0
          type: number
      - description: Quantile for responseTime metric.
        in: query
        name: responseTimeQuantile
        required: false
        schema:
          default: 0.5
          maximum: 1
          minimum: 0
          type: number
      - description: Threshold for slowRequests metric.
        in: query
        name: slowRequestsThreshold
        required: false
        schema:
          default: 1000
          minimum: 0
          type: integer
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          enum:
          - DataRobot-Consumer
          - DataRobot-Remote-IP
          - DataRobot-Host-IP
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceStatsForBatchRetrieveResponse'
          description: Service health metric data retrieved.
      summary: Retrieve service health metrics.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/capabilities/:
    get:
      description: Retrieve the capabilities for the deployment.
      operationId: deploymentsCapabilities_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCapabilitiesRetrieveResponse'
          description: ''
      summary: Retrieve capabilities.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/challengerPredictions/:
    post:
      description: Score main model prediction requests against challenger model requests.
      operationId: deploymentsChallengerPredictions_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChallengerScore'
      responses:
        '202':
          description: Job submitted. See Location header.
          headers:
            Location:
              description: URL to poll to track challenger scoring progress.
              schema:
                type: string
        '422':
          description: Unable to process the challenger scoring request.
        '429':
          description: Another challenger scoring job is running. See the Location
            header to track the running job.
      summary: Score challenger models
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/challengerReplaySettings/:
    get:
      description: Retrieve challenger replay settings.
      operationId: deploymentsChallengerReplaySettings_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChallengersReplaySettings'
          description: Challenger replay settings.
      summary: Retrieve challenger replay settings.
      tags:
      - deployments
      x-versionadded: v2.33
    patch:
      description: Update challenger replay settings.
      operationId: deploymentsChallengerReplaySettings_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChallengersReplaySettings'
      responses:
        '200':
          description: Challenger replay settings updated.
      summary: Update challenger replay settings.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/challengers/:
    get:
      description: List challenger models for deployment.
      operationId: deploymentsChallengers_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChallengerListResponse'
          description: The challenger models
      summary: List challenger models
      tags:
      - deployments
      x-versionadded: v2.23
    post:
      description: Create new challenger model.
      operationId: deploymentsChallengers_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChallengerCreate'
      responses:
        '202':
          description: Job submitted successfully. See Location header.
          headers:
            Location:
              description: URL to poll to track challenger creation has finished.
              schema:
                type: string
        '422':
          description: Unable to process the challenger creation request.
      summary: Create challenger model
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/challengers/{challengerId}/:
    delete:
      description: Delete challenger model.
      operationId: deploymentsChallengers_delete
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Unique identifier of the challenger.
        in: path
        name: challengerId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Model successfully deleted.
      summary: Delete challenger model
      tags:
      - deployments
      x-versionadded: v2.23
    get:
      description: Retrieve challenger model.
      operationId: deploymentsChallengers_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Unique identifier of the challenger.
        in: path
        name: challengerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChallengerResponse'
          description: The challenger model
      summary: Get challenger model
      tags:
      - deployments
      x-versionadded: v2.23
    patch:
      description: Update challenger model.
      operationId: deploymentsChallengers_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Unique identifier of the challenger.
        in: path
        name: challengerId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChallengerUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChallengerResponse'
          description: Model successfully updated.
      summary: Update challenger model
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/championModelPackage/:
    get:
      description: Retrieve information about the champion model package
      operationId: deploymentsChampionModelPackage_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageRetrieveResponseBase'
          description: Information retrieved successfully.
      summary: Retrieve information about the champion model package.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/customMetrics/:
    get:
      description: Retrieve a list of custom metrics.
      operationId: deploymentsCustomMetrics_list
      parameters:
      - description: Offset this number of objects to retrieve
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this number of objects to retrieve
        in: query
        name: limit
        required: false
        schema:
          default: 20
          maximum: 50
          minimum: 1
          type: integer
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricListResponse'
          description: Success
        '403':
          description: User does not have permission to access a particular deployment
            or create a custom metric.
      summary: Retrieve a list of custom metrics.
      tags:
      - deployments
      x-versionadded: v2.30
    post:
      description: Create a deployment custom metric.
      operationId: deploymentsCustomMetrics_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricCreatePayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricEntity'
          description: Custom metric is successfully created.
        '403':
          description: User does not have permission to create a custom metric.
      summary: Create a deployment custom metric.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/:
    delete:
      description: Delete a custom metric.
      operationId: deploymentsCustomMetrics_delete
      parameters:
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: A custom metric was successfully deleted.
        '403':
          description: User does not have permission to delete a custom metric.
        '404':
          description: Custom metric was not found.
      summary: Delete a custom metric.
      tags:
      - deployments
      x-versionadded: v2.30
    get:
      description: Retrieve a single custom metric metadata.
      operationId: deploymentsCustomMetrics_retrieve
      parameters:
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricEntity'
          description: A given custom metric metadata.
        '403':
          description: User does not have permission to access a particular deployment
            or custom metric metadata.
      summary: Retrieve a single custom metric metadata.
      tags:
      - deployments
      x-versionadded: v2.30
    patch:
      description: Update given custom metric settings.
      operationId: deploymentsCustomMetrics_patch
      parameters:
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricUpdatePayload'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricEntity'
          description: Custom metric settings updated.
        '403':
          description: User does not have permission to update the custom metric.
      summary: Update given custom metric settings.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/batchSummary/:
    get:
      description: Retrieve the summary of deployment batch custom metric.
      operationId: deploymentsCustomMetricsBatchSummary_retrieve
      parameters:
      - description: Start of the period to retrieve monitoring stats, defaults to
          7 days ago from the end of the period.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period to retrieve monitoring stats, defaults to the
          next top of the hour from now.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The model package ID of related champion/challenger to retrieve
          custom metric values for.
        in: query
        name: modelPackageId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomMetricBatchSummary'
          description: Summary retrieved successfully.
        '403':
          description: User does not have permission to read the custom metric summary.
      summary: Retrieve the summary of deployment batch custom metric.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch support for custom metrics.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_CUSTOM_METRICS
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromDataset/:
    post:
      description: Upload custom metric values from dataset.
      operationId: deploymentsCustomMetricsFromDataset_create
      parameters:
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricValuesFromDatasetPayload'
      responses:
        '202':
          description: Custom metric values import started
        '403':
          description: User does not have permission to import custom metric values.
      summary: Upload custom metric values from dataset.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromJSON/:
    post:
      description: Upload custom metric values from JSON.
      operationId: deploymentsCustomMetricsFromJSON_create
      parameters:
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricValuesFromJSONPayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricEntity'
          description: Custom metric values import started
        '403':
          description: User does not have permission to import custom metric values.
      summary: Upload custom metric values from JSON.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/summary/:
    get:
      description: Retrieve the summary of deployment custom metric.
      operationId: deploymentsCustomMetricsSummary_retrieve
      parameters:
      - description: Start of the period to retrieve monitoring stats, defaults to
          7 days ago from the end of the period.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period to retrieve monitoring stats, defaults to the
          next top of the hour from now.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The model package ID of related champion/challenger to retrieve
          custom metric values for.
        in: query
        name: modelPackageId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomMetricSummary'
          description: Summary retrieved successfully.
        '403':
          description: User does not have permission to read the custom metric summary.
      summary: Retrieve the summary of deployment custom metric.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverBatch/:
    get:
      description: Retrieve custom metric values over batch.
      operationId: deploymentsCustomMetricsValuesOverBatch_list
      parameters:
      - description: The model package ID of related champion/challenger to retrieve
          batch custom metric values for.
        in: query
        name: modelPackageId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The model ID of related champion/challenger to retrieve batch
          custom metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricValuesOverBatchResponse'
          description: Data retrieved successfully
        '403':
          description: User does not have permission to read custom metric values.
      summary: Retrieve custom metric values over batch.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch support for custom metrics.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_CUSTOM_METRICS
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverTime/:
    get:
      description: Retrieve custom metric values over time.
      operationId: deploymentsCustomMetricsValuesOverTime_list
      parameters:
      - description: Start of the period to retrieve monitoring stats, defaults to
          7 days ago from the end of the period.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period to retrieve monitoring stats, defaults to the
          next top of the hour from now.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The model package ID of related champion/challenger to retrieve
          custom metric values for.
        in: query
        name: modelPackageId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: Time duration of a bucket, default to seven days.
        in: query
        name: bucketSize
        required: false
        schema:
          default: P7D
          format: duration
          type: string
      - description: ID of the deployment
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the custom metric
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricValuesOverTimeResponse'
          description: Data retrieved successfully
        '403':
          description: User does not have permission to read custom metric values.
      summary: Retrieve custom metric values over time.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetricsBatchSummary/:
    get:
      description: Retrieve the bulk summary of deployment batch custom metrics.
      operationId: deploymentsCustomMetricsBulkBatchSummary_retrieve
      parameters:
      - description: Start of the period to retrieve monitoring stats, defaults to
          7 days ago from the end of the period.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period to retrieve monitoring stats, defaults to the
          next top of the hour from now.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The model package ID of related champion/challenger to retrieve
          custom metric values for.
        in: query
        name: modelPackageId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomMetricsBulkBatchSummary'
          description: Bulk summary retrieved successfully.
        '403':
          description: User does not have permission to read the custom metrics summary.
      summary: Retrieve the bulk summary of deployment batch custom metrics.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch support for custom metrics.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_CUSTOM_METRICS
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/customMetricsSummary/:
    get:
      description: Retrieve the bulk summary of deployment custom metrics.
      operationId: deploymentsCustomMetricsBulkSummary_retrieve
      parameters:
      - description: Start of the period to retrieve monitoring stats, defaults to
          7 days ago from the end of the period.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period to retrieve monitoring stats, defaults to the
          next top of the hour from now.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The model package ID of related champion/challenger to retrieve
          custom metric values for.
        in: query
        name: modelPackageId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomMetricsBulkSummary'
          description: Bulk summary retrieved successfully.
        '403':
          description: User does not have permission to read the custom metrics summary.
      summary: Retrieve the bulk summary of deployment custom metrics.
      tags:
      - deployments
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/fairnessScoresOverTime/:
    get:
      description: Retrieve fairness scores for all features, or for different classes
        of a single feature changes over a specific time period.
      operationId: deploymentsFairnessScoresOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: Time duration of buckets
        in: query
        name: bucketSize
        required: false
        schema:
          default: P1D
          enum:
          - PT1H
          - P1D
          - P7D
          - P1M
          type: string
      - description: The ID of the model to retrieve the statistics for.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The name of the fairness metric to compute fairness over time.
        in: query
        name: fairnessMetric
        required: false
        schema:
          enum:
          - proportionalParity
          - equalParity
          - favorableClassBalance
          - unfavorableClassBalance
          - trueUnfavorableRateParity
          - trueFavorableRateParity
          - favorablePredictiveValueParity
          - unfavorablePredictiveValueParity
          nullable: true
          type: string
      - description: Name of the protected feature. When present, will return per
          class fairness score of the protected feature, otherwise returning fairness
          score of all protected features.
        in: query
        name: protectedFeature
        required: false
        schema:
          type: string
      - description: The type of FairnessScore to order the response by.
        in: query
        name: orderBy
        required: false
        schema:
          default: relativeFairnessScore
          enum:
          - absoluteFairnessScore
          - relativeFairnessScore
          - -absoluteFairnessScore
          - -relativeFairnessScore
          type: string
      - description: Always include privileged class in response.
        in: query
        name: includePrivilegedClass
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Include only statistically significant attributes.
        in: query
        name: onlyStatisticallySignificant
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Max number of features in response.
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: Number of features to offset in response.
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FairnessOverTimeResponse'
          description: Fairness summary and over time.
      summary: Retrieve fairness over time info of the deployment.
      tags:
      - deployments
      x-versionadded: v2.31
  /api/v2/deployments/{deploymentId}/featureDrift/:
    get:
      description: Retrieve drift scores for features of the deployment.
      operationId: deploymentsFeatureDrift_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: ID of the model in the deployment. If not set, defaults to the
          deployment current model.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Name of the metric used to calculate the drift. Can be one of
          psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults
          to psi.
        in: query
        name: metric
        required: false
        schema:
          default: psi
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          type: string
      - description: The number of features to skip, defaults to 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of features to return, defaults to 25.
        in: query
        name: limit
        required: false
        schema:
          default: 200
          minimum: 0
          type: integer
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          type: string
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureDriftResponse'
          description: Features drift over specified time period retrieved.
      summary: Retrieve feature drift scores
      tags:
      - deployments
      x-versionadded: v2.21
  /api/v2/deployments/{deploymentId}/featureDriftOverBatch/:
    get:
      description: Retrieve drift over batch info for a feature of the deployment.
      operationId: deploymentsFeatureDriftOverBatch_list
      parameters:
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: List of feature names, limited to two per request.
        in: query
        name: featureNames
        required: true
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 2
            type: array
      - description: The metric used to calculate data drift scores.
        in: query
        name: driftMetric
        required: false
        schema:
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          nullable: true
          type: string
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureDriftOverBatchResponse'
          description: Drift over batch info for a feature of the deployment.
      summary: Retrieve drift over batch info for a feature of the deployment.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/featureDriftOverTime/:
    get:
      description: Retrieve drift over time info for a feature of the deployment.
      operationId: deploymentsFeatureDriftOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The time duration of a bucket. Needs to be multiple of one hour.
          Can not be longer than the total length of the period. If not set, a default
          value will be calculated based on the start and end time.
        in: query
        name: bucketSize
        required: false
        schema:
          format: duration
          type: string
      - description: The id of the model for which the features drift is being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: List of feature names, limited to two per request.
        in: query
        name: featureNames
        required: true
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 2
            type: array
      - description: Name of the metric used to calculate the drift. Can be one of
          psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults
          to psi.
        in: query
        name: metric
        required: false
        schema:
          default: psi
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          type: string
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          nullable: true
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureDriftOverTimeResponse'
          description: Feature drift over time info of the deployment retrieved.
        '400':
          description: Request invalid, refer to messages for detail.
        '403':
          description: Model Deployments and/or Monitoring are not enabled.
        '404':
          description: Either the deployment does not exist or user does not have
            permission to view the deployment.
      summary: Retrieve drift over time info for a feature of the deployment.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/features/:
    get:
      description: Retrieve features contained within the universe dataset associated
        with a specific deployment. By default, this returns all raw features required
        for predictions.
      operationId: deploymentsFeatures_list
      parameters:
      - description: The number of features to skip, defaults to 0.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of features to return, defaults to 0.
        in: query
        name: limit
        required: true
        schema:
          default: 50
          minimum: 0
          type: integer
      - description: When True will return all raw features in the universe dataset
          associated with the deployment, and when False will return only those raw
          features used to make predictions on the deployment.
        in: query
        name: includeNonPredictionFeatures
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.20
      - description: When True, features returned will be filtered to those usable
          for segmented analysis.
        in: query
        name: forSegmentedAnalysis
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Case insensitive search against names of the deployment's features.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          type: string
        x-versionadded: v2.24
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureListResponse'
          description: The deployment's features
        '422':
          description: Feature list retrieval is not supported on this deployment.
      summary: Get deployment features
      tags:
      - deployments
      x-versionadded: v2.18
  /api/v2/deployments/{deploymentId}/healthSettings/:
    get:
      description: Retrieve deployment health settings.
      operationId: deploymentsHealthSettings_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthSettings'
          description: Deployment health settings.
      summary: Retrieve deployment health settings.
      tags:
      - deployments
      x-versionadded: v2.33
    patch:
      description: Update deployment health settings.
      operationId: deploymentsHealthSettings_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthSettings'
      responses:
        '200':
          description: Updated deployment health settings.
      summary: Update deployment health settings.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/healthSettings/defaults/:
    get:
      description: Retrieve default deployment health settings.
      operationId: deploymentsHealthSettingsDefaults_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthSettings'
          description: Default deployment health settings.
      summary: Retrieve default deployment health settings.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/humilityStats/:
    get:
      description: Retrieve humility rule service triggers statistics overview.
      operationId: deploymentsHumilityStats_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The time duration of a bucket. Needs to be multiple of one hour.
          Can not be longer than the total length of the period. If not set, a default
          value will be calculated based on the start and end time.
        in: query
        name: bucketSize
        required: false
        schema:
          format: duration
          type: string
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          enum:
          - DataRobot-Consumer
          - DataRobot-Remote-IP
          - DataRobot-Host-IP
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HumilityStatsResponse'
          description: Humility service health statistics overview retrieved.
        '403':
          description: Model Deployments and/or Monitoring are not enabled.
        '404':
          description: Either the deployment does not exist or user does not have
            permission to view the deployment.
      summary: Retrieve humility stats
      tags:
      - deployments
      x-versionadded: v2.24
  /api/v2/deployments/{deploymentId}/humilityStatsOverTime/:
    get:
      description: Retrieve humility service statistics over time.
      operationId: deploymentsHumilityStatsOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The time duration of a bucket. Needs to be multiple of one hour.
          Can not be longer than the total length of the period. If not set, a default
          value will be calculated based on the start and end time.
        in: query
        name: bucketSize
        required: false
        schema:
          format: duration
          type: string
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          enum:
          - DataRobot-Consumer
          - DataRobot-Remote-IP
          - DataRobot-Host-IP
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HumilityStatsOverTimeResponse'
          description: Humility statistics for deployment retrieved.
        '403':
          description: Model Deployments and/or Monitoring are not enabled.
        '404':
          description: Either the deployment does not exist or user does not have
            permission to view the deployment.
      summary: Retrieve humility stats over time
      tags:
      - deployments
      x-versionadded: v2.24
  /api/v2/deployments/{deploymentId}/model/:
    patch:
      description: 'Replace the model used to make predictions for the deployment.

        A validation process will be performed to make sure the new model is eligible
        as a replacement. If the validation fails, the model replacement will not
        occur.The Model Replacement Validation endpoint can be used to confirm the
        new model is eligible as a replacement.'
      operationId: deploymentsModel_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelReplacementSubmission'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelReplacementValidationResponse'
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Model Replacement.
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/:
    get:
      description: Retrieve the secondary datasets configuration used by a deployed
        Feature discovery model.
      operationId: deploymentsModelSecondaryDatasetConfiguration_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecondaryDatasetConfigResponse'
          description: Secondary datasets configuration.
        '404':
          description: Deployment or secondary datasets configuration cannot be found
            for the deployed model.
      summary: Retrieve secondary datasets configuration for a deployment.
      tags:
      - deployments
      x-versionadded: v2.23
    patch:
      description: Update the secondary datasets configuration used by the deployed
        feature discovery model.
      operationId: deploymentsModelSecondaryDatasetConfiguration_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecondaryDatasetConfigUpdate'
      responses:
        '204':
          description: Secondary Datasets Configuration updated successfully.
        '403':
          description: Invalid credentials for secondary datasets configuration.
      summary: Update the secondary datasets configuration for the deployed model.
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfigurationHistory/:
    get:
      description: List all the secondary datasets configuration used by a given Feature
        Discovery deployment
      operationId: deploymentsModelSecondaryDatasetConfigurationHistory_list
      parameters:
      - description: Number of items to skip. Defaults to 0 if not provided.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of items to return, defaults to 100 if not provided.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          type: integer
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecondaryDatasetsConfigListResponse'
          description: Secondary Datasets Configuration history.
      summary: List the secondary datasets configuration history for a deployment
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/model/validation/:
    post:
      description: Validate that a model can be used to replace the current model
        of the deployment.
      operationId: deploymentsModelValidation_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelReplacementValidationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelReplacementValidationResponse'
          description: ''
      summary: Model Replacement Validation.
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/monitoringBatchLimits/:
    get:
      description: Get the limits related to monitoring batches.
      operationId: deploymentsMonitoringBatchLimits_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Get the limits related to monitoring batches.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/monitoringBatches/:
    get:
      description: List monitoring batches in a deployment.
      operationId: deploymentsMonitoringBatches_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: ID of the user who created a batch.
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: Search by matching batch name in a case-insensitive manner or
          exact match of batch ID.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Order of the returning batches.
        in: query
        name: orderBy
        required: false
        schema:
          default: -latestPredictionTimestamp
          enum:
          - name
          - -name
          - createdAt
          - -createdAt
          - earliestPredictionTimestamp
          - -earliestPredictionTimestamp
          - latestPredictionTimestamp
          - -latestPredictionTimestamp
          type: string
      - description: Filter for batches created after the given time
        in: query
        name: createdAfter
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter for batches created before the given time
        in: query
        name: createdBefore
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter for batches with a start time after the given time
        in: query
        name: startAfter
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter for batches with an end time before the given time
        in: query
        name: endBefore
        required: false
        schema:
          format: date-time
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringBatchListResponse'
          description: ''
      summary: List monitoring batches in a deployment.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
    post:
      description: Create a monitoring batch for a deployment.
      operationId: deploymentsMonitoringBatches_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringBatchCreateUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringBatch'
          description: ''
      summary: Create a monitoring batch for a deployment.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/:
    delete:
      description: Delete a monitoring batch in a deployment.
      operationId: deploymentsMonitoringBatches_delete
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the monitoring batch.
        in: path
        name: monitoringBatchId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Delete a monitoring batch in a deployment.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
    get:
      description: Retrieve a monitoring batch in a deployment.
      operationId: deploymentsMonitoringBatches_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the monitoring batch.
        in: path
        name: monitoringBatchId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringBatch'
          description: ''
      summary: Retrieve a monitoring batch in a deployment.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
    patch:
      description: Update a monitoring batch in a deployment.
      operationId: deploymentsMonitoringBatches_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the monitoring batch.
        in: path
        name: monitoringBatchId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringBatchCreateUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringBatch'
          description: ''
      summary: Update a monitoring batch in a deployment.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/:
    get:
      description: List information about models that have data in a monitoring batch.
      operationId: deploymentsMonitoringBatchesModels_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: ID of the model associated with a batch.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the monitoring batch.
        in: path
        name: monitoringBatchId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringBatchModelListResponse'
          description: ''
      summary: List information about models that have data in a monitoring batch.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/:
    get:
      description: Get information about a model that has data in a monitoring batch.
      operationId: deploymentsMonitoringBatchesModels_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the monitoring batch.
        in: path
        name: monitoringBatchId
        required: true
        schema:
          type: string
      - description: ID of the model.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringBatchModel'
          description: ''
      summary: Get information about a model that has data in a monitoring batch.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
    patch:
      description: Update information about model data in a batch.
      operationId: deploymentsMonitoringBatchesModels_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the monitoring batch.
        in: path
        name: monitoringBatchId
        required: true
        schema:
          type: string
      - description: ID of the model.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringBatchModelUpdate'
      responses:
        '200':
          description: ''
      summary: Update information about model data in a batch.
      tags:
      - deployments
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables batch monitoring for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_BATCH_MONITORING
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/monitoringDataDeletions/:
    post:
      description: Delete deployment monitoring data.
      operationId: deploymentsMonitoringDataDeletions_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringDataDeletePayload'
      responses:
        '200':
          description: ''
        '404':
          description: Deployment or model not found.
      summary: Endpoint for deleting deployment monitoring data.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/onDemandReports/:
    post:
      description: Add report to execution queue.
      operationId: deploymentsOnDemandReports_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledReportOnDemmand'
      responses:
        '200':
          description: Scheduled report job was addded to execution.
          headers:
            Location:
              description: URL to poll to track report generation has finished.
              schema:
                type: string
      summary: Add report to execution queue.
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/predictionDataExports/:
    get:
      description: A list of asynchronous prediction data exports.
      operationId: deploymentsPredictionDataExports_list
      parameters:
      - description: Specifies the number of rows to skip before starting to return
          rows from the query.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Specifies the number of rows to return after the offset.
        in: query
        name: limit
        required: false
        schema:
          default: 20
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: A prediction data export processing state.
        in: query
        name: status
        required: false
        schema:
          default: null
          enum:
          - CANCELLED
          - CREATED
          - FAILED
          - SCHEDULED
          - SUCCEEDED
          nullable: true
          type: string
      - description: Id of model used for prediction data export.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: If true, returns just the exports associated with batches. If
          false, just the real-time ones. If not provided, returns both real-time
          and batch exports.
        in: query
        name: batch
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionExportListResponse'
          description: The prediction data exports.
        '403':
          description: User does not have permission to access a particular deployment.
        '404':
          description: Resource not found.
        '422':
          description: Unable to process the prediction data exports list retrieval
            due to invalid parameter values.
      summary: A list prediction data exports.
      tags:
      - deployments
      x-versionadded: v2.33
    post:
      description: Create a deployment prediction data export.
      operationId: deploymentsPredictionDataExports_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportCreatePayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportEntity'
          description: Prediction data export successfully created.
        '403':
          description: User does not have permission to create a prediction data export.
        '404':
          description: Resource not found.
        '422':
          description: Unable to process the prediction data export creation request.
      summary: Create a deployment prediction data export.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/:
    get:
      description: Retrieve a single prediction data export.
      operationId: deploymentsPredictionDataExports_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Unique identifier of the export.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportEntity'
          description: A given prediction data export user can view is retrieved.
        '403':
          description: 'User does not have permission to access a particular deployment
            or prediction data export. '
        '404':
          description: Resource not found.
      summary: Retrieve a single prediction data export.
      tags:
      - deployments
      x-versionadded: v2.33
    patch:
      description: Update prediction data export.
      operationId: deploymentsPredictionDataExports_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Unique identifier of the export.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionDataUpdate'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportEntity'
          description: Prediction data export successfully updated.
        '403':
          description: User does not have permission to update a prediction data export.
        '404':
          description: Requested resource does not exist or the user does not have
            permission to view it.
        '422':
          description: Unable to process the prediction data export update.
      summary: Update prediction data export.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/predictionInputs/fromDataset/:
    post:
      description: Assigns prediction dataset to the external deployment to enable
        the analysis of historical model performance. Multiple datasets containing
        historical predictions for the external deployment can be uploaded. This requires
        one request for each dataset. For a regression deployment, predictions can
        be either an int or float. For a classification (binary/multiclass) deployment,
        predictions must be lists with each list containing probabilities for each
        class.
      operationId: deploymentsPredictionInputsFromDataset_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionDatasetAssignment'
      responses:
        '202':
          description: Submitted successfully.
        '405':
          description: Data can only be uploaded to an external deployment.
        '422':
          description: Unable to process predictions upload.
      summary: Submit external deployment prediction data.
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/predictionResults/:
    get:
      description: Retrieve predictions results of the deployment.
      operationId: deploymentsPredictionResults_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The id of the model for which prediction results are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Start of the period for which prediction results are being retrieved.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period for which prediction results are being retrieved.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The id of the batch for which prediction results are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
        x-versionadded: v2.31
      - description: Filters predictions results to only those who have actuals present
          or with missing actuals.
        in: query
        name: actualsPresent
        required: false
        schema:
          type: boolean
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          - text/csv
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionResultsListResponse'
            text/csv:
              schema:
                type: string
          description: ''
      summary: Retrieve predictions results.
      tags:
      - deployments
      x-versionadded: v2.20
  /api/v2/deployments/{deploymentId}/predictionsOverBatch/:
    get:
      description: Retrieve metrics about predictions, such as row count, mean predicted
        value, mean probabilities, and class distribution, over batches.
      operationId: deploymentsPredictionsOverBatch_list
      parameters:
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Include percentiles in the response, only applicable to deployments
          with binary classification and regression target.
        in: query
        name: includePercentiles
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionsOverBatchResponse'
          description: Predictions over batch info retrieved.
      summary: Retrieve prediction metadata over batches for a deployment.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/predictionsOverTime/:
    get:
      description: Retrieve metrics about predictions, such as row count, mean predicted
        value, mean probabilities, and class distribution, over a specific time range.
      operationId: deploymentsPredictionsOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: Time duration of buckets
        in: query
        name: bucketSize
        required: false
        schema:
          default: P1D
          enum:
          - PT1H
          - P1D
          - P7D
          - P1M
          type: string
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the models for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
      - description: Target class to filter out results.
        in: query
        name: targetClass
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
        x-versionadded: v2.31
      - description: Include percentiles in the response, only applicable to deployments
          with binary classification and regression target.
        in: query
        name: includePercentiles
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionsOverTimeResponse'
          description: Predictions over time info retrieved.
      summary: Retrieve metrics about predictions over time for a deployment.
      tags:
      - deployments
      x-versionadded: v2.31
  /api/v2/deployments/{deploymentId}/predictionsVsActualsOverBatch/:
    get:
      description: Retrieve metrics about predictions and actuals, such as mean predicted
        & actual value, predicted & actual class distribution, over a specific set
        of batches.
      operationId: deploymentsPredictionsVsActualsOverBatch_list
      parameters:
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: Target class to filter out results.
        in: query
        name: targetClass
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
        x-versionadded: v2.31
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionsVsActualsOverBatchResponse'
          description: Predictions vs actuals over batch info.
      summary: Retrieve metrics about predictions and actuals, such as mean predicted
        & actual value, predicted & actual class distribution, over a specific set
        of batches.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/predictionsVsActualsOverTime/:
    get:
      description: Retrieve metrics about predictions and actuals, such as mean predicted
        & actual value, predicted & actual class distribution, over a specific time
        range.
      operationId: deploymentsPredictionsVsActualsOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: Time duration of buckets
        in: query
        name: bucketSize
        required: false
        schema:
          default: P1D
          enum:
          - PT1H
          - P1D
          - P7D
          - P1M
          type: string
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the models for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
      - description: Target class to filter out results.
        in: query
        name: targetClass
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 5
            type: array
        x-versionadded: v2.31
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionsVsActualsOverTimeResponse'
          description: Predictions vs actuals over time info.
      summary: Retrieve predictions vs actuals over time info.
      tags:
      - deployments
      x-versionadded: v2.32
  /api/v2/deployments/{deploymentId}/retrainingPolicies/:
    get:
      description: Retrieve a list of deployment retraining policies.
      operationId: deploymentsRetrainingPolicies_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyListResponse'
          description: Retrieve a list of deployment retraining policies.
        '404':
          description: Deployment not found.
      summary: Endpoint for fetching a list of deployment retraining policies.
      tags:
      - deployments
      x-versionadded: v2.29
    post:
      description: Create a deployment retraining policy.
      operationId: deploymentsRetrainingPolicies_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrainingPolicyCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyRetrieve'
          description: ''
        '404':
          description: Deployment not found.
      summary: Endpoint for creating a deployment retraining policy.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/:
    delete:
      description: Delete a deployment retraining policy.
      operationId: deploymentsRetrainingPolicies_delete
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Delete a deployment retraining policy.
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for deleting a deployment retraining policy.
      tags:
      - deployments
      x-versionadded: v2.29
    get:
      description: Retrieve a deployment retraining policy.
      operationId: deploymentsRetrainingPolicies_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyRetrieve'
          description: Retrieve a deployment retraining policy.
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for fetching a deployment retraining policy.
      tags:
      - deployments
      x-versionadded: v2.29
    patch:
      description: Update a deployment retraining policy.
      operationId: deploymentsRetrainingPolicies_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrainingPolicyUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyRetrieve'
          description: ''
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for updating a deployment retraining policy.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/:
    get:
      description: Retrieve a list of deployment retraining policy runs.
      operationId: deploymentsRetrainingPoliciesRuns_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyRunListResponse'
          description: Retrieve a list of deployment retraining policy runs.
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for fetching a list of deployment retraining policy runs.
      tags:
      - deployments
      x-versionadded: v2.29
    post:
      description: Initiate a deployment retraining policy run.
      operationId: deploymentsRetrainingPoliciesRuns_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for initiating a deployment retraining policy run.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/:
    get:
      description: Retrieve a single deployment retraining policy run.
      operationId: deploymentsRetrainingPoliciesRuns_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy run.
        in: path
        name: runId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyRunRetrieve'
          description: Retrieve a single deployment retraining policy run.
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for fetching a single deployment retraining policy run.
      tags:
      - deployments
      x-versionadded: v2.29
    patch:
      description: Update a single deployment retraining policy run.
      operationId: deploymentsRetrainingPoliciesRuns_patch
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy.
        in: path
        name: retrainingPolicyId
        required: true
        schema:
          type: string
      - description: ID of the retraining policy run.
        in: path
        name: runId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrainingPolicyRunUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingPolicyRunRetrieve'
          description: Update a single deployment retraining policy run.
        '404':
          description: Deployment or retraining policy not found.
      summary: Endpoint for updating a single deployment retraining policy run.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/retrainingSettings/:
    get:
      description: Retrieve deployment retraining settings.
      operationId: deploymentsRetrainingSettings_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrainingSettingsRetrieve'
          description: Retrieve deployment retraining settings.
        '404':
          description: Deployment not found.
      summary: Endpoint for fetching deployment retraining settings.
      tags:
      - deployments
      x-versionadded: v2.29
    patch:
      description: Update deployment retraining settings.
      operationId: deploymentsRetrainingSettings_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrainingSettingsUpdate'
      responses:
        '200':
          description: Update deployment retraining settings.
        '404':
          description: Deployment not found.
      summary: Endpoint for updating deployment retraining settings.
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/scoringCode/:
    get:
      description: "Retrieve Scoring Code of the current deployed model for making\
        \ predictions outside of a DataRobot prediction server.\nYou need the \"Scoring\
        \ Code\" feature enabled to use this route.\n\nBy default, returns a compiled\
        \ executable JAR that can be executed locally to calculate model predictions,\
        \ or it can be used as a library for a Java application. Execute it with the\
        \ '--help` parameters to learn how to use it as a command-line utility.\n\
        See model API documentation at https://javadoc.io/doc/com.datarobot/datarobot-prediction/latest/index.html\
        \ to be able to use it inside an existing Java application.\n\nWith sourceCode\
        \ query parameter set to 'true', returns a source code archive that can be\
        \ used to review internal calculations of the model.\nThis JAR is NOT executable.\n\
        \nSee \"https://docs.datarobot.com/en/docs/predictions/port-pred/scoring-code/index.html\"\
        \ documentation in DataRobot application for more information.\n\n*Note*\n\
        Cannot retrieve source code if agent is included.\n    "
      operationId: deploymentsScoringCode_list
      parameters:
      - description: Whether source code or binary of the Scoring Code will be retrieved
        in: query
        name: sourceCode
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Whether the Scoring code retrieved will include tracking agent
        in: query
        name: includeAgent
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Please use includePredictionExplanations parameter instead
        in: query
        name: includePe
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versiondeprecated: v2.28
      - description: Whether the Scoring Code retrieved will include prediction explanations
        in: query
        name: includePredictionExplanations
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.28
      - description: Whether the Scoring Code retrieved will include prediction intervals
        in: query
        name: includePredictionIntervals
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.28
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: JAR file
          headers:
            Content-Disposition:
              description: Indicating the content is supposed to be downloaded as
                an attachment
              schema:
                type: string
            Content-Type:
              description: application/java-archive
              schema:
                type: string
      summary: Retrieve Scoring Code
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/scoringCodeBuilds/:
    post:
      description: Build Java package containing Scoring Code with agent integration.
      operationId: deploymentsScoringCodeBuilds_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentsScoringCodeBuildPayload'
      responses:
        '200':
          description: ''
      summary: Build Java package containing Scoring Code with agent integration.
      tags:
      - deployments
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/serviceStats/:
    get:
      description: Retrieve all deployment service health metrics over a single period
        of time.
      operationId: deploymentsServiceStats_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: Quantile for executionTime metric.
        in: query
        name: executionTimeQuantile
        required: false
        schema:
          default: 0.5
          maximum: 1
          minimum: 0
          type: number
      - description: Quantile for responseTime metric.
        in: query
        name: responseTimeQuantile
        required: false
        schema:
          default: 0.5
          maximum: 1
          minimum: 0
          type: number
      - description: Threshold for slowRequests metric.
        in: query
        name: slowRequestsThreshold
        required: false
        schema:
          default: 1000
          minimum: 0
          type: integer
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          enum:
          - DataRobot-Consumer
          - DataRobot-Remote-IP
          - DataRobot-Host-IP
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The monitoring type for which segment attributes and segment
          values are being retrieved. Can be one of three options which corresponds
          to a deployment monitoring tab
        in: query
        name: monitoringType
        required: false
        schema:
          default: serviceHealth
          enum:
          - serviceHealth
          - dataDrift
          - accuracy
          - humility
          - batchServiceHealth
          - batchDataDrift
          - batchAccuracy
          - customMetrics
          - batchCustomMetrics
          type: string
        x-versiondeprecated: v2.30
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceStatsForTimeRangeResponse'
          description: Service health metric data retrieved.
      summary: Retrieve service health metrics.
      tags:
      - deployments
      x-versionadded: v2.18
  /api/v2/deployments/{deploymentId}/serviceStatsOverBatch/:
    get:
      description: Retrieve values for one single deployment service health metric
        over batch.
      operationId: deploymentsServiceStatsOverBatch_list
      parameters:
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          enum:
          - DataRobot-Consumer
          - DataRobot-Remote-IP
          - DataRobot-Host-IP
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: A service health metric.
        in: query
        name: metric
        required: false
        schema:
          default: totalPredictions
          enum:
          - totalPredictions
          - totalRequests
          - slowRequests
          - executionTime
          - responseTime
          - userErrorRate
          - serverErrorRate
          - numConsumers
          - cacheHitRatio
          type: string
      - description: Quantile for executionTime and responseTime metrics
        in: query
        name: quantile
        required: false
        schema:
          default: 0.5
          maximum: 1
          minimum: 0
          type: number
      - description: Threshold for slowQueries metric.
        in: query
        name: threshold
        required: false
        schema:
          default: 1000
          minimum: 0
          type: integer
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceStatsOverBatchResponse'
          description: Service health metric data retrieved.
      summary: Retrieve service health metric over batch
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/serviceStatsOverTime/:
    get:
      description: Retrieve values for one single deployment service health metric
        over time.
      operationId: deploymentsServiceStatsOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The time duration of a bucket. Needs to be multiple of one hour.
          Can not be longer than the total length of the period. If not set, a default
          value will be calculated based on the start and end time.
        in: query
        name: bucketSize
        required: false
        schema:
          format: duration
          type: string
      - description: Name of the metric. See below for a list of supported metrics.
        in: query
        name: metric
        required: false
        schema:
          default: totalPredictions
          enum:
          - totalPredictions
          - totalRequests
          - slowRequests
          - executionTime
          - responseTime
          - userErrorRate
          - serverErrorRate
          - numConsumers
          - cacheHitRatio
          - medianLoad
          - peakLoad
          type: string
      - description: A quantile for resulting data, used if `metric` is `executionTime`
          or `responseTime`, defaults to 0.5.
        in: query
        name: quantile
        required: false
        schema:
          maximum: 1
          minimum: 0
          type: number
      - description: A threshold for filtering results, used if `metric` is `slowQueries`,
          defaults to 1000.
        in: query
        name: threshold
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          enum:
          - DataRobot-Consumer
          - DataRobot-Remote-IP
          - DataRobot-Host-IP
          type: string
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceStatsOverTimeResponse'
          description: Service health metric data retrieved.
      summary: Retrieve service health metric over time
      tags:
      - deployments
      x-versionadded: v2.18
  /api/v2/deployments/{deploymentId}/settings/:
    get:
      description: Retrieve deployment settings.
      operationId: deploymentsSettings_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentSettingsResponse'
          description: The deployment settings
        '404':
          description: Either the deployment does not exist or the user does not have
            permission to view the deployment.
      summary: Get deployment settings
      tags:
      - deployments
      x-versionadded: v2.17
    patch:
      description: Updates deployment settings.
      operationId: deploymentsSettings_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentSettingsUpdate'
      responses:
        '202':
          description: Job submitted.  See Location header.
          headers:
            Location:
              description: the location to poll for settings update status
              schema:
                format: url
                type: string
        '403':
          description: User can view deployment but does not have permission to update
            settings.
        '404':
          description: Either the deployment does not exist or the user does not have
            permission to view the deployment.
        '409':
          description: The proposed settings changes are invalid and would result
            in a logical conflict.
        '422':
          description: The provided settings changes could not be processed.
      summary: Update deployment settings
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this deployment and their roles.
      operationId: deploymentsSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The deployment ID.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: ''
        '404':
          description: Either the deployment does not exist or the user does not have
            permissions to view the deployment.
        '422':
          description: Both username and userId were specified
      summary: Get model deployment's access control list
      tags:
      - deployments
      x-versionadded: v2.21
    patch:
      description: Set roles for users on this model deployment.
      operationId: deploymentsSharedRoles_patchMany
      parameters:
      - description: The deployment ID.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdateWithGrant'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the project without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update model deployment's controls
      tags:
      - deployments
      x-versionadded: v2.22
  /api/v2/deployments/{deploymentId}/status/:
    patch:
      description: Change deployment status.
      operationId: deploymentsStatus_patchMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentStatusUpdate'
      responses:
        '202':
          description: Job submitted. See Location header.
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '409':
          description: Deployment is already in process of status change or already
            in requested status.
        '422':
          description: Deployment status change request could not be processed.
      summary: Change deployment status
      tags:
      - deployments
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/targetDrift/:
    get:
      description: Retrieve target drift data.
      operationId: deploymentsTargetDrift_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: An ID of the model in the deployment. If not set, defaults to
          the deployment current model.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Metric used to calculate drift score.
        in: query
        name: metric
        required: false
        schema:
          default: psi
          enum:
          - psi
          - kl_divergence
          - dissimilarity
          - hellinger
          - js_divergence
          type: string
      - description: The name of a segment attribute used for segment analysis.
        in: query
        name: segmentAttribute
        required: false
        schema:
          type: string
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          nullable: true
          type: string
        x-versionadded: v2.20
      - description: The id of the batch for which metrics are being retrieved.
        in: query
        name: batchId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 25
            type: array
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetDriftResponse'
          description: Target drift over specified time period retrieved.
      summary: Retrieve target drift
      tags:
      - deployments
      x-versionadded: v2.21
  /api/v2/deployments/{deploymentId}/trainingDataExports/:
    get:
      description: A list of successful training data exports.
      operationId: deploymentsTrainingDataExports_list
      parameters:
      - description: Specifies the number of rows to skip before starting to return
          rows from the query.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Specifies the number of rows to return after the offset.
        in: query
        name: limit
        required: false
        schema:
          default: 20
          exclusiveMinimum: true
          maximum: 20
          minimum: 0
          type: integer
      - description: Id of model used for training data export.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          nullable: true
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrainingDataExportListResponse'
          description: The training data exports.
        '403':
          description: User does not have permission to access a particular deployment.
        '404':
          description: Resource not found.
        '422':
          description: Unable to process the training data exports list retrieval
            due to invalid parameter values.
      summary: A list training data exports.
      tags:
      - deployments
      x-versionadded: v2.33
    post:
      description: Create a deployment training data export.
      operationId: deploymentsTrainingDataExports_create
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainingDataExportCreatePayload'
      responses:
        '202':
          description: Training data export successfully enqueued.
          headers:
            Location:
              description: URL to poll to get status of job that waits for the training
                data export to finish
              schema:
                type: string
        '403':
          description: User does not have permission to create a training data export.
        '404':
          description: Resource not found.
        '422':
          description: Unable to process the training data export request.
      summary: Create a deployment training data export.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/:
    get:
      description: Retrieve a single training data export details.
      operationId: deploymentsTrainingDataExports_retrieve
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: Unique identifier of the export.
        in: path
        name: exportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrainingDataExportEntity'
          description: A given training data export user can view is retrieved.
        '403':
          description: 'User does not have permission to access a particular deployment
            or training data export. '
        '404':
          description: Resource not found.
      summary: Retrieve a single training data export details.
      tags:
      - deployments
      x-versionadded: v2.33
  /api/v2/entityNotificationChannels/:
    post:
      description: Create a new entity notification channel.
      operationId: entityNotificationChannels_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationChannelCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationChannelResponse'
          description: Entity notification channel created successfully.
      summary: Create entity notification channel
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/:
    get:
      description: List the notification channels related to the entity according
        to the query.
      operationId: entityNotificationChannels_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Only return the notification channels whose names contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationChannelsListResponse'
          description: Entity notification channels listed successfully.
      summary: List of notification channels related to the entity.
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/:
    delete:
      description: Delete the entity notification channel.
      operationId: entityNotificationChannels_delete
      parameters:
      - description: The id of the entity notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '204':
          description: Entity otification channel deleted successfully.
      summary: Delete entity notification channel
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    get:
      description: Retrieve the entity notification channel.
      operationId: entityNotificationChannels_retrieve
      parameters:
      - description: The id of the entity notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationChannelResponse'
          description: Entity notification channel retrieved successfully.
      summary: Retrieve entity notification channel
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    put:
      description: Update the entity notification channel.
      operationId: entityNotificationChannels_put
      parameters:
      - description: The id of the entity notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelWithDREntityUpdate'
      responses:
        '204':
          description: Entity notification channel updated successfully.
        '400':
          description: Email verification code is invalid.
      summary: Update entity notification channel
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicies/:
    post:
      description: Create a new entity notification policy.
      operationId: entityNotificationPolicies_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyResponse'
          description: Entity notification policy created successfully.
      summary: Create entity notification policy
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/:
    get:
      description: List the entity notification policies that satisfy the query condition.
      operationId: entityNotificationPolicies_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Return policies with this channel.
        in: query
        name: channelId
        required: false
        schema:
          type: string
      - description: Only return the notification channels whose names contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: Return policies with this event group.
        in: query
        name: eventGroup
        required: false
        schema:
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
      - description: Scope of the channel.
        in: query
        name: channelScope
        required: false
        schema:
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPoliciesListResponse'
          description: Entity notification policies listed successfully.
      summary: List entity notification policies
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/:
    delete:
      description: Delete the entity notification policy.
      operationId: entityNotificationPolicies_delete
      parameters:
      - description: The id of the notification policy
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '204':
          description: Entity notification policy deleted successfully.
      summary: Delete entity notification policy
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    get:
      description: Retrieve the entity notification policy.
      operationId: entityNotificationPolicies_retrieve
      parameters:
      - description: The id of the notification policy
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyResponse'
          description: Entity notification policy retrieved successfully.
      summary: Retrieve entity notification policy
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    put:
      description: Update the entity notification policy.
      operationId: entityNotificationPolicies_put
      parameters:
      - description: The id of the notification policy
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: The id of related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyUpdate'
      responses:
        '204':
          description: Entity notification policy updated successfully.
      summary: Update entity notification policy
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPoliciesFromTemplate/:
    post:
      description: Create a new entity notification policy from template.
      operationId: entityNotificationPoliciesFromTemplate_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyCreateFromTemplate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyResponse'
          description: Entity notification policy created successfully.
      summary: Create entity notification policy from template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicyTemplates/:
    post:
      description: Create a new entity notification policy template.
      operationId: entityNotificationPolicyTemplates_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyTemplateCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyTemplateResponse'
          description: Entity notification policy template created successfully.
      summary: Create entity notification policy template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/:
    get:
      description: List the entity notification policies templates that satisfy the
        query condition.
      operationId: entityNotificationPolicyTemplates_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Return policies with this channel.
        in: query
        name: channelId
        required: false
        schema:
          type: string
      - description: Only return the notification channels whose names contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: Return policies with this event group.
        in: query
        name: eventGroup
        required: false
        schema:
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPoliciesTemplatesListResponse'
          description: Entity notification policies templates listed successfully.
      summary: List entity notification policies templates
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/:
    delete:
      description: Delete the entity notification policy template.
      operationId: entityNotificationPolicyTemplates_delete
      parameters:
      - description: The id of the notification policy template
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '204':
          description: Entity notification policy template deleted successfully.
      summary: Delete entity notification policy template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    get:
      description: Retrieve the entity notification policy template.
      operationId: entityNotificationPolicyTemplates_retrieve
      parameters:
      - description: The id of the notification policy template
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyTemplateResponse'
          description: Entity notification policy template retrieved successfully.
      summary: Retrieve entity notification policy template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    put:
      description: Update the entity notification policy template.
      operationId: entityNotificationPolicyTemplates_put
      parameters:
      - description: The id of the notification policy template
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyTemplateUpdate'
      responses:
        '204':
          description: Entity notification policy template updated successfully.
      summary: Update entity notification policy template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/relatedPolicies/:
    get:
      description: Retrieve list of all policies that are created from this template
        and are visible for user
      operationId: entityNotificationPolicyTemplatesRelatedPolicies_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The id of the notification policy template
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyTemplateRelatedPoliciesListResponse'
          description: List of all policies that are created from this template and
            are visible for user
      summary: Retrieve list of all policies that are created from this template and
        are visible for user
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this registered model and their roles on the registered model.
      operationId: entityNotificationPolicyTemplatesSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The id of the notification policy template
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The registered model's access control list.
        '404':
          description: Either the Registered Model does not exist or the user does
            not have permissions to view the Registered Model.
        '422':
          description: Both username and userId were specified
      summary: Get registered model's access control list
      tags:
      - notifications
      x-versionadded: v2.33
    patch:
      description: Set roles for users on this registered model.
      operationId: entityNotificationPolicyTemplatesSharedRoles_patchMany
      parameters:
      - description: The id of the notification policy template
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: Type of related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the registered model without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update registered model's controls
      tags:
      - notifications
      x-versionadded: v2.33
  /api/v2/eventLogs/:
    get:
      description: Retrieve one page of audit log records.
      operationId: eventLogs_list
      parameters:
      - description: The project to select log records for.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: The user to select log records for.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The organization to select log records for.
        in: query
        name: orgId
        required: false
        schema:
          type: string
      - description: The event type of records.
        in: query
        name: event
        required: false
        schema:
          enum:
          - ADLS OAuth Failed
          - ADLS OAuth Token Obtained
          - ADLS OAuth Token Renewal Succeeded
          - ADLS OAuth User Login Started
          - ADLS OAuth User Login Succeeded
          - API Key Created
          - API Key Deleted
          - API Key Updated
          - Abort Autopilot
          - Access granted to a resource for a subject entity
          - Access granted to a resource referenced by an experiment container
          - Access request created
          - Access revoked to a resource for a subject entity
          - Access revoked to a resource referenced by an experiment container
          - Activate account
          - Activated On First Login
          - Actuals Uploaded
          - Add Model
          - Add New Dataset For Predictions
          - Add SAML configuration
          - Advanced Tuning Requested
          - App Config Changed
          - Approval Workflow Policy Action
          - Approval Workflow Policy Created
          - Approval Workflow Policy Deleted
          - Approval Workflow Policy Updated
          - Approve account
          - Association ID Set
          - Automated Application Access Revoked from the Group
          - Automated Application Access Revoked from the Organization
          - Automated Application Access Revoked from the User
          - Automated Application Created
          - Automated Application Deleted
          - Automated Application Domain Prefix Changed
          - Automated Application Duplicated
          - Automated Application Shared
          - Automated Application Shared with Group
          - Automated Application Shared with Organization
          - Automated Application Upgraded
          - Automated Demo Application Created
          - Automated Document Created
          - Automated Document Deleted
          - Automated Document Downloaded
          - Automated Document Previewed
          - Automated Document Requested
          - Available Forecast Points Computation Job Started
          - Base Image Built
          - Batch Monitoring Disabled
          - Batch Monitoring Enabled
          - Batch Prediction Created from Dataset
          - Batch prediction job aborted
          - Batch prediction job completed
          - Batch prediction job created
          - Batch prediction job failed
          - Batch prediction job started
          - Bias And Fairness Cross Class Calculated
          - Bias And Fairness Insights Calculated
          - Bias And Fairness Per Class Calculated
          - Bias and Fairness monitoring settings updated.
          - Bias and Fairness protected features specified.
          - Blending Models Limit Exceeded
          - Bulk Datasets Deleted
          - Bulk Datasets Tags Appended
          - CCM Balancer Terminated
          - CCM CLUSTER Reprovisioned
          - CCM Cluster Created
          - CCM Cluster Terminated
          - CCM Resource Group Created
          - Calculation of prediction intervals is requested
          - Challenger Insight Generation Started
          - Challenger Model Created
          - Challenger Model Deleted
          - Challenger Model Promoted
          - Challenger Models Disabled
          - Challenger Models Enabled
          - Change Request Cancelled
          - Change Request Created
          - Change Request Reopened
          - Change Request Resolved
          - Change Request Review Added
          - Change Request Updated
          - Change password
          - Child Entity Associated With Workspace In AI Catalog
          - Child Entity Disassociated From Workspace In AI Catalog
          - Clustering Cluster Names Updated
          - Codespace Created
          - Codespace Deleted
          - Codespace Metadata Edited
          - Codespace Session Started
          - Codespace Session Stopped
          - Comment Created
          - Comment Deleted
          - Comment Updated
          - Completed Feature Discovery Secondary Datasets
          - Completed Feature Discovery for Primary Dataset
          - Compliance Doc Deleted
          - Compliance Doc Downloaded
          - Compliance Doc Generated
          - Compliance Doc Previewed
          - Compute Cluster Added
          - Compute Cluster Deleted
          - Compute Cluster Updated
          - Compute External Insights
          - Compute Reason Codes
          - Create account
          - Created dataset from Data Engine workspace
          - Created dataset version from Data Engine workspace
          - Credential Created
          - Credential Deleted
          - Credential Updated
          - Credential Values Retrieved Based On OAuth Configuration ID
          - Custom Application Access Revoked from the Group
          - Custom Application Access Revoked from the Organization
          - Custom Application Access Revoked from the User
          - Custom Application Created
          - Custom Application Deleted
          - Custom Application Failed to Start
          - Custom Application Image Access Revoked from the Group
          - Custom Application Image Access Revoked from the Organization
          - Custom Application Image Access Revoked from the User
          - Custom Application Image Shared with Group
          - Custom Application Image Shared with Organization
          - Custom Application Image Shared with User
          - Custom Application Shared with Group
          - Custom Application Shared with Organization
          - Custom Application Shared with User
          - Custom Application Started
          - Custom Application Stopped
          - Custom Application Visited
          - Custom Application Visited by Guest
          - Custom Job Run Executed
          - Custom Metric Bulk Upload Succeeded
          - Custom Metric Creation Succeeded
          - Custom Metric Dataset Upload Succeeded
          - Custom Metric JSON Upload Succeeded
          - Custom Model Conversion Failed
          - Custom Model Conversion Files Uploaded
          - Custom Model Conversion Succeeded
          - Custom RBAC Access Role Created
          - Custom RBAC Access Role Deleted
          - Custom RBAC Access Role Updated
          - Custom Registered Model Created
          - Custom Registered Model Version Added
          - Custom Task Deploy
          - Custom Task Fit
          - Custom inference model added
          - Custom inference model assign training data request received
          - Custom inference model updated
          - Custom inference model version assign training data request received
          - Custom model item added
          - Custom task added
          - Custom task updated
          - Custom task version added
          - Data Connection Created
          - Data Connection Deleted
          - Data Connection Tested
          - Data Connection Updated
          - Data Matching ANN Index Profile Built
          - Data Matching Query Requested
          - Data Sample Queried For Wrangling
          - Data Sampled for Chunk Definition
          - Data Source is created
          - Data Sources Permadelete Executed
          - Data Sources Permadelete Failed
          - Data Sources Permadelete Submitted
          - Data Store Config Request Submitted
          - Data Stores Permadelete Executed
          - Data Stores Permadelete Failed
          - Data Stores Permadelete Submitted
          - Data engine query generator created
          - Data engine query generator deleted
          - Data engine workspace created
          - Data engine workspace deleted
          - Data engine workspace state previewed
          - Data engine workspace updated
          - Dataset Categories Modified
          - Dataset Column Aliases Modified
          - Dataset Created
          - Dataset Deleted
          - Dataset Description Modified
          - Dataset Download
          - Dataset Materialized
          - Dataset Name Modified
          - Dataset Reloaded
          - Dataset Shared
          - Dataset Sharing Removed
          - Dataset Tags Modified
          - Dataset Undeleted
          - Dataset Upload
          - Dataset Upload is Completed
          - Dataset Version Deleted
          - Dataset Version Undeleted
          - Dataset featurelist created
          - Dataset featurelist deleted
          - Dataset featurelist updated
          - Dataset for predictions with actual value column processed
          - Dataset refresh job created
          - Dataset refresh job deleted
          - Dataset refresh job updated
          - Dataset relationship created
          - Dataset relationship updated
          - Dataset transform created
          - Datasets Permadelete Executed
          - Datasets Permadelete Failed
          - Datasets Permadelete Submitted
          - Deactivate Account
          - Decision Flow Created
          - Decision Flow Model Package Created
          - Decision Flow Test Downloaded
          - Decision Flow Version Created
          - Decision Flow Version Deleted
          - Default value for Do-Not-Derive is changed
          - Delete SAML configuration
          - Deny account
          - Deploy Model To Hadoop
          - Deployment Activated
          - Deployment Actuals Export Created
          - Deployment Added
          - Deployment Deactivated
          - Deployment Deleted
          - Deployment Humility Rule Added
          - Deployment Humility Rule Deleted
          - Deployment Humility Rule Submitted
          - Deployment Humility Rule Updated
          - Deployment Humility Setting Updated
          - Deployment Monitoring Batch Created
          - Deployment Monitoring Timeliness Setting Changed
          - Deployment Permanently Erased
          - Deployment Processing Limit Interval Changed
          - Deployment Statistics Reset
          - Deployment prediction export created
          - Deployment prediction warning setting updated
          - Deployment training data export created
          - 'Detected Data Quality: Disguised Missing Values'
          - 'Detected Data Quality: Excess Zero'
          - 'Detected Data Quality: Imputation Leakage'
          - 'Detected Data Quality: Inconsistent Gaps'
          - 'Detected Data Quality: Inliers'
          - 'Detected Data Quality: Lagged Features'
          - 'Detected Data Quality: Leading or Trailing Series'
          - 'Detected Data Quality: Missing Documents'
          - 'Detected Data Quality: Missing Images'
          - 'Detected Data Quality: Multicategorical Invalid Format'
          - 'Detected Data Quality: New Series in Recent Data'
          - 'Detected Data Quality: Outliers'
          - 'Detected Data Quality: Quantile Target Sparsity'
          - 'Detected Data Quality: Quantile Target Zero Inflation'
          - 'Detected Data Quality: Target Leakage'
          - 'Detected Data Quality: Target had infrequent negative values'
          - Do-Not-Derive is used
          - Documentation Request
          - Download All Charts
          - Download Chart
          - Download Codegen
          - Download Codegen From Deployment
          - Download Deployment Chart
          - Download Model
          - Download Model Package
          - Download Model Package From Deployment
          - Download Predictions
          - Empty Catalog Item Created
          - Empty Cluster Status Created
          - Entitlement Definition Created
          - Entitlement Definition Deleted
          - Entitlement Definition Updated
          - Entitlement Set Created
          - Entitlement Set Deleted
          - Entitlement Set Updated
          - Entitlement Set Updated Entitlements
          - Entity notification channel created
          - Ephemeral Session Started
          - Ephemeral Session Stopped
          - Experiment Container Created
          - Experiment Container Dataset Registered
          - Experiment Container Dataset Unregistered
          - 'Experiment Container Deleted '
          - Experiment Container Entity Linked
          - Experiment Container Entity Migrated
          - Experiment Container Entity Moved
          - Experiment Container Entity Unlinked
          - Experiment Container Reference To Catalog Dataset Removed
          - Experiment Container Reference To Catalog Dataset Version Removed
          - Experiment Container Updated
          - External Predictions Configured
          - External Registered Model Created
          - External Registered Model Version Added
          - FEAR Predict Job Started
          - Failed Decision Flow Test
          - Feature Discovery Relationship Quality Assessment Inputs Metrics
          - Feature Discovery Relationship Quality Assessment Warnings Metrics
          - Feature Over Geo Computed
          - Finish Autopilot
          - First Login After DR Account Migration
          - General Feedback Submitted
          - Generic Custom Job Created
          - Generic Custom Job Manual Run Created
          - Generic Custom Job Scheduled Run Created
          - Geometry Over Geo Computed
          - Geospatial Feature Transform Created
          - Geospatial Primary Location Column Selected
          - Global SAML Configuration Added
          - Global SAML Configuration Deleted
          - Global SAML Configuration Updated
          - Group Members Updated
          - Group created
          - Group deleted
          - Group updated
          - Hosted Custom Metric Custom Job Created
          - Hosted Custom Metric Deployment Connection Created
          - Interaction Feature Created
          - Interaction Feature Deployment Created
          - Invitation Accepted
          - Invitation sent
          - Job definition created
          - Job definition updated
          - Login Fail
          - Login Succeeded Via Global SAML SSO
          - Login Success Via SAML SSO
          - Login Successful
          - Logout
          - MLOPS Integrations Deployment Launched
          - MLOPS Integrations Deployment Model Replaced
          - MLOPS Integrations Deployment Stopped
          - MLOPS Integrations Prediction Environment Created
          - MLOPS Integrations Prediction Environment Deleted
          - MLOps Installer Download Request Received
          - Managed Image Built
          - Model Deployment Shared
          - Model Insights Job Submitted
          - Models Starred
          - Multi-Factor Auth Disable
          - Multi-Factor Auth Enable
          - Multilabel Labelwise ROC With Missing TPR Or FPR Requested
          - Native Registered Model Created
          - Native Registered Model Version Added
          - Network Policy Created
          - Network Policy Deleted
          - Network Policy Updated
          - No predictors are left because of Do-Not-Derive
          - Non Existent Value Tracker Attachment Removed
          - Notebook Created
          - Notebook Deleted
          - Notebook Environment Variable Deleted
          - Notebook Environment Variable Edited
          - Notebook Environment Variables Created
          - Notebook Environment Variables Deleted
          - Notebook Metadata Edited
          - Notebook Revision Created
          - Notebook Revision Deleted
          - Notebook Revision Restored
          - Notebook Schedule Created
          - Notebook Schedule Deleted
          - Notebook Schedule Disabled
          - Notebook Schedule Enabled
          - Notebook Schedule Launched
          - Notebook Session Started
          - Notebook Session Stopped
          - Notification Channel Deleted
          - Notification Channel Template Created
          - Notification Channel Template Updated
          - Notification Custom Job Created
          - Notification Policy Created
          - Notification Policy Created From Template
          - Notification Policy Deleted
          - Notification Policy Template Created
          - Notification Policy Template Deleted
          - Notification Policy Template Updated
          - Notification Policy Updated
          - Notification channel created
          - Notification channel deleted
          - Notification channel updated
          - Notification policy created
          - Notification policy deleted
          - Notification policy updated
          - Number of bias mitigation jobs on Autopilot stage.
          - Online Conformal PI Calculation Requested
          - Organization Perma-Deletion Completed
          - Organization Perma-Deletion Failed
          - Organization Perma-Deletion Marked
          - Organization Perma-Deletion Requested
          - Organization Perma-Deletion Started
          - Organization Perma-Deletion Unmarked
          - Organization created
          - Organization deleted
          - Organization updated
          - Organizations Perma-Deletion Requested
          - PPS Docker Image Download Request Received
          - Period accuracy file validation failed
          - Period accuracy file validation successful
          - Period accuracy insight computed
          - Pipeline downsampling build and run started.
          - Pipeline downsampling run failed to start.
          - Predictions by Forecast Date Settings Updated
          - Prime Downloaded
          - Prime Run
          - Project Access Revoked from the Group
          - Project Access Revoked from the Organization
          - Project Access Revoked from the User
          - Project Autopilot Configured
          - Project Cloned
          - Project Created
          - Project Created from Dataset
          - Project Created from Project Export File
          - Project Created from Wrangled Dataset
          - Project Deleted
          - Project Description Updated
          - Project Exported as Project Export File
          - Project Options Retrieved
          - Project Options Updated
          - Project Permadelete Executed
          - Project Permadelete Failed
          - Project Permadelete Submitted
          - Project Renamed
          - Project Restored
          - Project Shared
          - Project Shared with Group
          - Project Shared with Organization
          - Project Target Selected
          - Published Recipe Data Uploaded
          - Rate limit user group changed
          - Recipe Access Revoked from Group
          - Recipe Access Revoked from Organization
          - Recipe Access Revoked from User
          - Recipe Created
          - Recipe Deleted
          - Recipe Published
          - Recipe Shared
          - Recipe Shared with Group
          - Recipe Shared with Organization
          - Recipe metadata updated
          - Registered Model Shared
          - Registered Model Updated
          - Registered Model Version Stage Transitioned
          - Registered Model Version Updated
          - Replaced Model
          - Request External Insights
          - Request External Insights - All Datasets
          - Request Model Insights
          - Restart Autopilot
          - Restore Reduced Features
          - Retraining Custom Job Created
          - Retraining Policy Cancelled
          - Retraining Policy Created
          - Retraining Policy Deleted
          - Retraining Policy Failed
          - Retraining Policy Started
          - Retraining Policy Succeeded
          - RuleFit Code Downloaded
          - SHAP Impact Computed
          - SHAP Matrix Computed
          - SHAP Predictions Explanations Computed
          - SHAP Predictions Explanations Preview Computed
          - SHAP Training Predictions Explanations Computed
          - Secure Configuration Created
          - Secure Configuration Deleted
          - Secure Configuration Shared
          - Secure Configuration Sharing Removed
          - Secure Configuration Values Updated
          - Segment Analysis Enabled
          - Segment Attributes Specified
          - Select Model Metric
          - ServiceUser Created
          - ServiceUser Deleted
          - ServiceUser Impersonated Token Requested
          - ServiceUser Token Requested
          - ServiceUser Updated
          - Start Autopilot
          - Successful Decision Flow Test
          - Successful Login using OIDC flow
          - Successful Login using OIDC token exchange
          - Successful Login via Google Idp
          - Target is set as Do-Not-Derive
          - Tenant Created
          - Tenant Encryption Key generated and managed by DataRobot KMS
          - Tenant Encryption Key rotated
          - Tenant Encryption Key scheduled for deletion
          - Tenant Encryption Key was set for the tenant
          - Tenant Perma-Deletion Completed
          - Tenant Perma-Deletion Failed
          - Tenant Perma-Deletion Requested
          - Tenant Perma-Deletion Started
          - Tenant Updated
          - Text prediction explanations computed
          - Train Model
          - Unsupervised Mode Started
          - Update SAML configuration
          - Update account
          - User Agreement Accepted
          - User Agreement Declined
          - User Append Columns Download With Predictions
          - User Blueprint Added To Repository
          - User Blueprint Created
          - User Blueprint Deleted
          - User Blueprint Deleted In Bulk
          - User Blueprint Description Modified
          - User Blueprint Name Modified
          - User Blueprint Retrieved
          - User Blueprint Tags Modified
          - User Blueprint Tasks Retrieved
          - User Blueprint Updated
          - User Blueprint Validated
          - User Blueprints Listed
          - User Provisioned From JWT
          - Users Perma-Deletion Canceled
          - Users Perma-Deletion Canceling
          - Users Perma-Deletion Completed
          - Users Perma-Deletion Failed
          - Users Perma-Deletion Preview Building Canceled
          - Users Perma-Deletion Preview Building Canceling
          - Users Perma-Deletion Preview Building Completed
          - Users Perma-Deletion Preview Building Failed
          - Users Perma-Deletion Preview Building Started
          - Users Perma-Deletion Preview Building Submitted
          - Users Perma-Deletion Started
          - Users Perma-Deletion Submitted
          - Value Tracker Attachment Added
          - Value Tracker Attachment Removed
          - Value Tracker Created
          - Value Tracker Stage Changed
          - Value Tracker Updated
          - Workspace Description Modified
          - Workspace Marked As Deleted In AI Catalog
          - Workspace Modified
          - Workspace Name Modified
          - Workspace Registered In AI Catalog
          - Workspace Scheduled Batch Run Failed
          - Workspace Scheduled Batch Run Started
          - Workspace Scheduled Batch Run Succeeded
          - Workspace Tags Modified
          - Workspace scheduled batch processing job created
          - Workspace scheduled batch processing job deleted
          - Workspace scheduled batch processing job updated
          - aiAPI Portal Login
          type: string
      - description: The lower bound for timestamps. E.g. '2016-12-13T11:12:13.141516Z'.
        in: query
        name: minTimestamp
        required: false
        schema:
          format: date-time
          type: string
      - description: The upper bound for timestamps. E.g. '2016-12-13T11:12:13.141516Z'.
        in: query
        name: maxTimestamp
        required: false
        schema:
          format: date-time
          type: string
      - description: This many results will be skipped. Defaults to 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The order of the results. Defaults to descending.
        in: query
        name: order
        required: false
        schema:
          default: desc
          enum:
          - asc
          - desc
          type: string
      - description: Indicates if identifying information like user names, project
          names, etc. should be included or not. Defaults to True.
        in: query
        name: includeIdentifyingFields
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.17
      - description: Indicates which type of event to return - must be one of ``APP_USAGE``
          for application related events (i.e. Project Created, Dataset Uploaded,
          etc.) or ``ADMIN_USAGE`` for admin related events (i.e. Reset API Token
          for User, Organization Created, etc.). If not provided, all events will
          be returned by default.
        in: query
        name: auditReportType
        required: false
        schema:
          enum:
          - APP_USAGE
          - ADMIN_USAGE
          type: string
        x-versionadded: v2.17
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogsRetrieveResponse'
          description: A list of audit log records.
      summary: Retrieve one page of audit log records.
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/eventLogs/events/:
    get:
      description: Retrieve all the available events. DEPRECATED API.
      operationId: eventLogsEvents_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogsEventListResponse'
          description: A list of events.
      summary: Retrieve all the available events. DEPRECATED API.
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/eventLogs/predictionUsage/:
    get:
      description: Retrieve prediction usage data. ``CAN_ACCESS_USER_ACTIVITY`` permission
        is required.
      operationId: eventLogsPredictionUsage_list
      parameters:
      - description: The project to retrieve prediction usage for.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: The user to retrieve prediction usage for.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The lower bound for timestamps. E.g. '2016-12-13T11:12:13.141516Z'.
        in: query
        name: minTimestamp
        required: true
        schema:
          format: date-time
          type: string
      - description: The upper bound for timestamps. Time range should not exceed
          24 hours. E.g. '2016-12-13T11:12:13.141516Z'.
        in: query
        name: maxTimestamp
        required: true
        schema:
          format: date-time
          type: string
      - description: The order of prediction usage rows sorted by ``timestamp``. Defaults
          to descending.
        in: query
        name: order
        required: false
        schema:
          default: desc
          enum:
          - asc
          - desc
          type: string
      - description: This many results will be skipped. Defaults to 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Indicates if identifying information like user names, project
          names, etc should be included or not. Defaults to True.
        in: query
        name: includeIdentifyingFields
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.17
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionUsageRetrieveResponse'
          description: A list of prediction events.
      summary: Retrieve prediction usage data.
      tags:
      - analytics
      x-versionadded: v2.17
  /api/v2/eventLogs/{recordId}/:
    get:
      description: Get audit record by ID.
      operationId: eventLogs_retrieve
      parameters:
      - description: Indicates if identifying information like user names, project
          names, etc should be included or not. Defaults to True.
        in: query
        name: includeIdentifyingFields
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.17
      - description: The id of the audit log.
        in: path
        name: recordId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogsRetrieveOneResponse'
          description: The queried audit record.
      summary: Get audit record by ID.
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/executionEnvironments/{environmentId}/accessControl/:
    get:
      description: Get a list of users who have access to this execution environment
        and their roles.
      operationId: executionEnvironmentsAccessControl_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Optional, only return the access control information for a user
          with this username.
        in: query
        name: username
        required: false
        schema:
          type: string
      - description: Optional, only return the access control information for a user
          with this user ID.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListResponse'
          description: ''
        '400':
          description: Bad Request. Both username and userId were specified
        '403':
          description: Forbidden. The user does not have permissions to view the execution
            environment access list.
        '404':
          description: Execution environment not found. Either the execution environment
            does not exist or user does not have permission to view it.
      summary: Get a list of users who have access to this execution environment and
        their roles.
      tags:
      - models
      x-versionadded: v2.25
    patch:
      description: Grant access or update roles for users on this execution environment.
        Up to 100 user roles may be set in a single request.
      operationId: executionEnvironmentsAccessControl_patchMany
      parameters:
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingUpdateOrRemoveWithGrant'
      responses:
        '200':
          description: ''
        '204':
          description: Roles updated successfully.
        '403':
          description: User can view execution environment but does not have permission
            to grant these roles on the execution environment.
        '404':
          description: Either the execution environment does not exist or the user
            does not have permissions to view the execution environment.
        '409':
          description: The request would leave the execution environment without an
            owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid.
      summary: Grant access or update roles for users on this execution environment.
      tags:
      - models
      x-versionadded: v2.25
  /api/v2/externalDataDriverFile/:
    post:
      description: Upload JDBC driver from file. Only Java archive (.jar) files are
        supported.
      operationId: externalDataDriverFile_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DriverUploadRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverUploadResponse'
          description: ''
        '413':
          description: JDBC driver JAR file size exceeds the configured limit.
      summary: Upload JDBC driver from file.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataDrivers/:
    get:
      description: Fetch all drivers a user has access to.
      operationId: externalDataDrivers_list
      parameters:
      - description: Driver type. Either 'jdbc' or 'dr-database-v1'.
        in: query
        name: type
        required: true
        schema:
          default: jdbc
          enum:
          - all
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        x-versionadded: v2.30
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverListResponse'
          description: Drivers accessible by the user.
      summary: List drivers
      tags:
      - data_connectivity
      x-versionadded: v2.11
    post:
      description: Create a new JDBC driver. To create connections from fields, rather
        than supplying a JDBC URL, use 'configurationId'. When using 'configurationId',
        do not include 'canonicalName' or 'className' as they are part of the driver
        configuration. Specifying a 'version' is required as it is used in the construction
        of the canonicalName.
      operationId: externalDataDrivers_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDriverRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverResponse'
          description: Details about new driver entity.
      summary: Create a new JDBC driver.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataDrivers/{driverId}/:
    delete:
      description: Delete the driver with given ID if it is not used by any data store
        or data source.
      operationId: externalDataDrivers_delete
      parameters:
      - description: Driver ID.
        in: path
        name: driverId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Driver deleted successfully.
        '409':
          description: Driver is in use by one or more data store or data source
      summary: Delete the driver.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    get:
      description: Retrieve driver details by ID.
      operationId: externalDataDrivers_retrieve
      parameters:
      - description: Driver ID.
        in: path
        name: driverId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverResponse'
          description: Driver details retrieved successfully.
      summary: Retrieve driver details.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    patch:
      description: Update properties of an existing JDBC driver. To change the canonicalName
        and className, you must first remove the driver configuration, if it exists,
        as its properties will otherwise override name changes.
      operationId: externalDataDrivers_patch
      parameters:
      - description: Driver ID.
        in: path
        name: driverId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDriverRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverResponse'
          description: Driver properties updated successfully.
      summary: Update properties of an existing JDBC Driver.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataDrivers/{driverId}/configuration/:
    get:
      description: Retrieve the driver configuration with the specified ID.
      operationId: externalDataDriversConfiguration_list
      parameters:
      - description: Driver ID.
        in: path
        name: driverId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverConfigurationRetrieveResponse'
          description: Driver configuration retrieved successfully.
      summary: Driver configuration details.
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalDataSources/:
    get:
      description: Return detailed list of available data sources.
      operationId: externalDataSources_list
      parameters:
      - description: Data source type to filter by.
        in: query
        name: type
        required: false
        schema:
          default: databases
          enum:
          - all
          - databases
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceListResponse'
          description: Data sources retrieved successfully.
      summary: List data sources.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    post:
      description: 'Create a fully configured source of data which could be used for
        datasets and projects creation.A `data source` specifies, via SQL query or
        selected table and schema data, which data to extract from the `data connection`
        (the location of data within a given endpoint) to use for modeling or predictions.
        A `data source` has one `data connection` and one `connector` but can have
        many `datasets`.

        To test the SQL query before creating the data source,use :http:post:`/api/v2/externalDataStores/(dataStoreId)/verifySQL/`.'
      operationId: externalDataSources_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceRetrieveResponse'
          description: Data source created successfully.
      summary: Create a data source.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataSources/{dataSourceId}/:
    delete:
      description: Delete the data source with given ID if it is not used by any dataset.
      operationId: externalDataSources_delete
      parameters:
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Data source deleted successfully.
        '409':
          description: Data source is in use by one or more datasets
      summary: Delete the data source.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    get:
      description: Return details of the existing data source with given ID, including
        SQL query or selected table and schema data, which fully describe which data
        to extract and from which location.
      operationId: externalDataSources_retrieve
      parameters:
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceRetrieveResponse'
          description: Data source details retrieved successfully.
      summary: Data source details.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    patch:
      description: 'Update the data source with given ID.

        To test the SQL query before updating the data source,use :http:post:`/api/v2/externalDataStores/(dataStoreId)/verifySQL/`.'
      operationId: externalDataSources_patch
      parameters:
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceUpdate'
      responses:
        '204':
          description: Data source updated successfully.
      summary: Update the data source.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataSources/{dataSourceId}/accessControl/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this data source and their roles.
      operationId: externalDataSourcesAccessControl_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Optional, only return the access control information for a user
          with this username.
        in: query
        name: username
        required: false
        schema:
          type: string
      - description: Optional, only return the access control information for a user
          with this user ID.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListResponse'
          description: The data source's access control list.
        '404':
          description: Either the data source does not exist or the user does not
            have permissions to view the data source.
        '422':
          description: Both username and userId were specified
      summary: Get data source's access control list
      tags:
      - data_connectivity
      x-versionadded: v2.14
    patch:
      description: Set roles for users on this data source. Note that when granting
        access to a data source, access to the corresponding data store as a "CONSUMER"
        will also be granted.
      operationId: externalDataSourcesAccessControl_patchMany
      parameters:
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingUpdateOrRemoveWithGrant'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the data source without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update data source's access controls
      tags:
      - data_connectivity
      x-versionadded: v2.14
  /api/v2/externalDataSources/{dataSourceId}/permissions/:
    get:
      description: Describe what permissions current user has for given data source.
      operationId: externalDataSourcesPermissions_list
      parameters:
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceDescribePermissionsResponse'
          description: The data source permissions.
      summary: Describe data source permissions.
      tags:
      - data_connectivity
      x-versionadded: v2.23
  /api/v2/externalDataSources/{dataSourceId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this data source and their roles.
      operationId: externalDataSourcesSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRolesWithGrantListResponse'
          description: A paginated list of user/group/organization roles.
      summary: Get data source's access control list
      tags:
      - data_connectivity
      x-versionadded: v2.22
    patch:
      description: Grant access, remove access or update roles for organizations,
        groups or users on this data source. Up to 100 roles may be set per array
        in a single request.
      operationId: externalDataSourcesSharedRoles_patchMany
      parameters:
      - description: The ID of the Data Source.
        in: path
        name: dataSourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdateWithGrant'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: Duplicate entry for the org/group/user in roles listor the
            request would leave the data source without an owner.
        '422':
          description: Request is unprocessable. For example, `name` is stated for
            not user recipient.
      summary: Modify data source shared roles.
      tags:
      - data_connectivity
      x-versionadded: v2.22
  /api/v2/externalDataStores/:
    get:
      description: Return list with details of the existing data stores available
        for the user.
      operationId: externalDataStores_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Includes only data stores of the specified type or any if set
          to `all`.
        in: query
        name: type
        required: false
        schema:
          default: jdbc
          enum:
          - all
          - databases
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        x-versionadded: v2.22
      - description: Includes only data stores of the specified database type. For
          JDBC based data stores, the database_type value is the string between the
          first and the second colons of a jdbc url. For example, a snowflake jdbc
          url is jdbc:snowflake://, the database_type is hence snowflake. If an empty
          string is used, or if the string contains only whitespace, no filtering
          occurs.
        in: query
        name: databaseType
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
        x-versionadded: v2.30
      - description: Includes only data stores of the specified connector type.
        in: query
        name: connectorType
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Specifies whether non-visible OAuth fields are shown.
        in: query
        name: showHidden
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreListResponse'
          description: Data stores retrieved successfully.
        '422':
          description: Filtering by database type is currently not supported for dr-connector-v1
            data stores
      summary: List data stores.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    post:
      description: Create a data store which includes a name and a driver ID or a
        connector ID. The driver would be configured by a JDBC URL or by jdbc fields;
        The connector would be configured by connection fields.
      operationId: externalDataStores_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreRetrieveResponse'
          description: Data store created successfully.
      summary: Create a data store.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/:
    delete:
      description: Delete the data store with given ID if it is not used by any data
        source.
      operationId: externalDataStores_delete
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Data store deleted successfully.
        '409':
          description: Data store is in use by one or more data source
      summary: Delete the data store.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    get:
      description: 'A configured connection to a database - it has a name and a specified
        driver. The driver may be specified by a JDBC URL or connection parameters
        if the driver was created with the parameter configuration. '
      operationId: externalDataStores_retrieve
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreRetrieveResponse'
          description: Data store details retrieved successfully.
      summary: Data store details.
      tags:
      - data_connectivity
      x-versionadded: v2.11
    patch:
      description: Updates a data store configuration.
      operationId: externalDataStores_patch
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreRetrieveResponse'
          description: Returns the updated data store entry.
      summary: Updates a data store configuration.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/accessControl/:
    patch:
      description: Set roles for users on this data store.
      operationId: externalDataStoresAccessControl_patchMany
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingUpdateOrRemoveWithGrant'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the data store without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update data store's controls
      tags:
      - data_connectivity
      x-versionadded: v2.14
  /api/v2/externalDataStores/{dataStoreId}/columns/:
    post:
      description: Retrieves a data store's data columns.
      operationId: externalDataStoresColumns_create
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreColumnsList'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreColumnsListResponse'
          description: Returns response with array of Column objects.
        '400':
          description: Error thrown by DSS system when retrieving columns
        '403':
          description: Incorrect permissions to access catalog item through DSS
      summary: Retrieves a data store's data columns.
      tags:
      - data_connectivity
      x-versionadded: v2.28
  /api/v2/externalDataStores/{dataStoreId}/columnsInfo/:
    post:
      description: Retrieves a data store's column metadata.
      operationId: externalDataStoresColumnsInfo_create
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Includes only credentials of the specified type. Repeat the parameter
          for filtering on multiple statuses.
        in: query
        name: types
        required: false
        schema:
          oneOf:
          - enum:
            - adls_gen2_oauth
            - api_token
            - azure
            - azure_service_principal
            - basic
            - bearer
            - databricks_access_token_account
            - databricks_service_principal_account
            - gcp
            - oauth
            - rsa
            - s3
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_service_principal
              - basic
              - bearer
              - databricks_access_token_account
              - databricks_service_principal_account
              - gcp
              - oauth
              - rsa
              - s3
              - snowflake_key_pair_user_account
              - snowflake_oauth_user_account
              - tableau_access_token
              type: string
            type: array
      - description: The order to sort the credentials. Defaults to the order by the
          creation_date in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - creationDate
          - -creationDate
          type: string
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreColumnsInfoList'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreColumnsInfoListResponse'
          description: Retrieves a data store's column metadata.
        '409':
          description: This operation is only allowed for JDBC data stores.
      summary: Retrieves a data store's column metadata.
      tags:
      - data_connectivity
      x-versionadded: v2.30
  /api/v2/externalDataStores/{dataStoreId}/credentials/:
    get:
      description: Returns a list of credentials associated with the specified data
        store.
      operationId: externalDataStoresCredentials_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Includes only credentials of the specified type. Repeat the parameter
          for filtering on multiple statuses.
        in: query
        name: types
        required: false
        schema:
          oneOf:
          - enum:
            - adls_gen2_oauth
            - api_token
            - azure
            - azure_service_principal
            - basic
            - bearer
            - databricks_access_token_account
            - databricks_service_principal_account
            - gcp
            - oauth
            - rsa
            - s3
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_service_principal
              - basic
              - bearer
              - databricks_access_token_account
              - databricks_service_principal_account
              - gcp
              - oauth
              - rsa
              - s3
              - snowflake_key_pair_user_account
              - snowflake_oauth_user_account
              - tableau_access_token
              type: string
            type: array
      - description: The order to sort the credentials. Defaults to the order by the
          creation_date in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - creationDate
          - -creationDate
          type: string
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsListResponse'
          description: List of credentials associated with the data store.
      summary: List credentials associated with the specified data store.
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalDataStores/{dataStoreId}/permissions/:
    get:
      description: Describe what permissions current user has for given data store.
      operationId: externalDataStoresPermissions_list
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreDescribePermissionsResponse'
          description: The data store permissions.
      summary: Describe data store permissions.
      tags:
      - data_connectivity
      x-versionadded: v2.23
  /api/v2/externalDataStores/{dataStoreId}/schemas/:
    post:
      description: Retrieves a data store's data schemas.
      operationId: externalDataStoresSchemas_create
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreCredentials'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreSchemasList'
          description: Returns response with schemas and catalog.
      summary: Retrieves a data store's data schemas.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/sharedRoles/:
    get:
      description: Get a list of users who have access to this data store and their
        roles on the data store.
      operationId: externalDataStoresSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRolesWithGrantListResponse'
          description: The data store's access control list.
        '404':
          description: Either the data store does not exist or the user does not have
            permissions to view the data store.
        '422':
          description: Both username and userId were specified
      summary: Get data store's access control list
      tags:
      - data_connectivity
      x-versionadded: v2.22
    patch:
      description: Grant access, remove access or update roles for organizations,
        groups or users on this data store. Up to 100 roles may be set per array in
        a single request.
      operationId: externalDataStoresSharedRoles_patchMany
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdateWithGrant'
      responses:
        '204':
          description: Successfully modified.
        '409':
          description: Duplicate entry for the org/group/user in roles listor the
            request would leave the data store without an owner.
        '422':
          description: Request is unprocessable. For example, `name` is stated for
            not user recipient.
      summary: Modify data store shared roles.
      tags:
      - data_connectivity
      x-versionadded: v2.22
  /api/v2/externalDataStores/{dataStoreId}/tables/:
    post:
      description: Retrieves a data store's database tables (including views).
      operationId: externalDataStoresTables_create
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreTables'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreTablesList'
          description: List of tables available in the retrieved data store.
      summary: Retrieves a data store's database tables (including views).
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/test/:
    post:
      description: Tests the ability to connect to a data store with specified authentication.
      operationId: externalDataStoresTest_create
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreCredentialsWithCredentialsTypeSupport'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreTestResponse'
          description: Outcome of the connection test.
        '400':
          description: Details on why the connect call failed.
      summary: Tests data store connection.
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/verifySQL/:
    post:
      description: Executes the SQL query on the data store, returning a small number
        of rows (max 999). Use this for quick query execution validation and exploring
        results, not for capturing an entire result set.
      operationId: externalDataStoresVerifySQL_create
      parameters:
      - description: ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataStoreSQLVerify'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreSQLVerifyResponse'
          description: Returns the names of columns and a limited number of results
            from the SQL query.
        '400':
          description: Details explaining why the SQL query is invalid.
      summary: Verifies a SQL query for a data store.
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalDriverConfigurations/:
    get:
      description: Retrieve matching driver configurations based on query.
      operationId: externalDriverConfigurations_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Type of driver configurations to return.
        in: query
        name: type
        required: false
        schema:
          default: jdbc
          enum:
          - all
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
      - description: If True, include hidden configurations in response.
        in: query
        name: showHidden
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverConfigurationListResponse'
          description: Driver configurations retrieved successfully.
      summary: List available driver configurations.
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalDriverConfigurations/{configurationId}/:
    get:
      description: Retrieve the driver configuration with the specified ID.
      operationId: externalDriverConfigurations_retrieve
      parameters:
      - description: Driver configuration ID
        in: path
        name: configurationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverConfigurationRetrieveResponse'
          description: Driver configuration retrieved successfully.
      summary: Driver configuration details.
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/groups/:
    delete:
      description: Delete the user groups.
      operationId: groups_deleteMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupBulkDelete'
      responses:
        '204':
          description: ''
        '422':
          description: Multiple user groups found by the identifier.
      summary: Delete multiple user groups
      tags:
      - user_management
      x-versionadded: v2.26
    get:
      description: List the user groups that satisfy the query condition.
      operationId: groups_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 50
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: User groups must contain the substring.
        in: query
        name: namePart
        required: false
        schema:
          default: ''
          type: string
      - description: List user groups for the organization. If the value is `unowned`,
          the route will filter for groups that aren't owned by any organization.
        in: query
        name: orgId
        required: false
        schema:
          oneOf:
          - enum:
            - unowned
            type: string
          - type: string
      - description: List user groups that the user is part of.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: Indicates if the search by `namePart` should exclude the groups
          that the user with userId is a member.
        in: query
        name: excludeUserMembership
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The order that the results should be retrieved in. Prefix the
          attribute name with a dash to sort in descending order, e.g. `orderBy=-name`.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - name
          - -name
          - orgName
          - -orgName
          - accessRoleName
          - -accessRoleName
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupsListResponse'
          description: ''
      summary: List user groups
      tags:
      - user_management
      x-versionadded: v2.0
    post:
      description: Create a new user group.
      operationId: groups_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupResponse'
          description: ''
        '422':
          description: Unable to process the request.
      summary: Create user group
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/groups/{groupId}/:
    delete:
      description: Delete the user group.
      operationId: groups_delete
      parameters:
      - description: The identifier of the user group.
        in: path
        name: groupId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '422':
          description: Multiple user groups found by the identifier.
      summary: Delete user group
      tags:
      - user_management
      x-versionadded: v2.26
    get:
      description: Retrieve the user group.
      operationId: groups_retrieve
      parameters:
      - description: The identifier of the user group.
        in: path
        name: groupId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupResponse'
          description: ''
        '422':
          description: Multiple user groups found by the identifier.
      summary: Retrieve user group
      tags:
      - user_management
      x-versionadded: v2.26
    patch:
      description: Update the user group.
      operationId: groups_patch
      parameters:
      - description: The identifier of the user group.
        in: path
        name: groupId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupResponse'
          description: ''
        '422':
          description: Unable to process the request.
      summary: Update user group
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/groups/{groupId}/users/:
    delete:
      description: Remove users from the group.
      operationId: groupsUsers_deleteMany
      parameters:
      - description: The identifier of the user group.
        in: path
        name: groupId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyUsersInGroup'
      responses:
        '204':
          description: ''
        '422':
          description: The user was not found.
      summary: Remove users from group
      tags:
      - user_management
      x-versionadded: v2.26
    get:
      description: List users in the group.
      operationId: groupsUsers_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 50
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: User groups must contain the substring.
        in: query
        name: namePart
        required: false
        schema:
          default: ''
          type: string
      - description: The order that the results should be retrieved in. Prefix the
          attribute name with a dash to sort in descending order, e.g. `orderBy=-username`.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - username
          - -username
          - userGroup
          - -userGroup
          - lastName
          - -lastName
          - firstName
          - -firstName
          - status
          - -status
          - expirationDate
          - -expirationDate
          type: string
        x-versionadded: v2.22
      - description: If specified, filters results by account activation status.
        in: query
        name: isActive
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: If specified, filters results to admin users (system and org)
          or non-admin users.
        in: query
        name: isAdmin
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The identifier of the user group.
        in: path
        name: groupId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersInGroupResponse'
          description: ''
      summary: List users in group
      tags:
      - user_management
      x-versionadded: v2.26
    post:
      description: Add users to the group.
      operationId: groupsUsers_create
      parameters:
      - description: The identifier of the user group.
        in: path
        name: groupId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyUsersInGroup'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddUsersToGroupResponse'
          description: ''
        '422':
          description: Unable to process the request, or if the user does not belong
            to the group's organization, or if one is already in the maximum number
            of groups, or if the user is not found.
      summary: Add users to group
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/hdfsProjects/:
    post:
      description: 'Create a project from an HDFS file via WebHDFS API. Represent
        the file using URL, optionally, port, and optionally, user/password credentials.
        For example, `{"url": "hdfs://<ip>/path/to/file.csv", "port": "50070"}`.'
      operationId: hdfsProjects_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HdfsProjectCreate'
      responses:
        '200':
          description: ''
      summary: Create a project from an HDFS file source.
      tags:
      - projects
      x-versionadded: v2.4
  /api/v2/imageAugmentationLists/:
    get:
      description: List of augmentation lists that match the specified query.
      operationId: imageAugmentationLists_list
      parameters:
      - description: Project ID to retrieve augmentation lists from
        in: query
        name: projectId
        required: true
        schema:
          type: string
      - description: Name of the image feature that the augmentation list is associated
          with
        in: query
        name: featureName
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. To specify no limit,
          use 0. The default may change without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationListsResponse'
          description: Image Augmentation Lists
      summary: List of augmentation lists that match the specified query.
      tags:
      - images
      x-versionadded: v2.23
    post:
      description: Creates a new augmentation list based on the posted payload data.
      operationId: imageAugmentationLists_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageAugmentationListsCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationListCreateResponse'
          description: Augmentation list id
        '422':
          description: Unable to create image augmentation list with the given input
      summary: Creates a new augmentation list based on the posted payload data.
      tags:
      - images
      x-versionadded: v2.23
  /api/v2/imageAugmentationLists/{augmentationId}/:
    delete:
      description: Delete an existing augmentation lists by id
      operationId: imageAugmentationLists_delete
      parameters:
      - description: The id of the augmentation list to fetch
        in: path
        name: augmentationId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The successful response is empty
        '400':
          description: Cannot delete an augmentation list that is marked as in_use.
      summary: Delete an existing augmentation lists by id
      tags:
      - images
      x-versionadded: v2.23
    get:
      description: Returns a single augmentation list with the specified id.
      operationId: imageAugmentationLists_retrieve
      parameters:
      - description: The id of the augmentation list to fetch
        in: path
        name: augmentationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationListsRetrieve'
          description: Returns an augmentation list object
      summary: Returns a single augmentation list with the specified id.
      tags:
      - images
      x-versionadded: v2.23
    patch:
      description: Update an existing augmentation list, with passed in values.
      operationId: imageAugmentationLists_patch
      parameters:
      - description: The id of the augmentation list to fetch
        in: path
        name: augmentationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageAugmentationListPatchParam'
      responses:
        '204':
          description: The successful response is empty
      summary: Update an existing augmentation list, with passed in values.
      tags:
      - images
      x-versionadded: v2.23
  /api/v2/imageAugmentationLists/{augmentationId}/samples/:
    get:
      description: Retrieve latest Augmentation Samples generated for list
      operationId: imageAugmentationListsSamples_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The id of the augmentation list
        in: path
        name: augmentationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationListsRetrieveSamplesResponse'
          description: ''
        '404':
          description: Augmentation Samples not found
      summary: Retrieve latest Augmentation Samples generated for list
      tags:
      - images
      x-versionadded: v2.27
    post:
      description: This endpoint will schedule a job to augment the specified images
        from a project's dataset and return a link to monitor the status of the job,
        as well as a link to retrieve the resulting augmented images.
      operationId: imageAugmentationListsSamples_create
      parameters:
      - description: The id of the augmentation list
        in: path
        name: augmentationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageAugmentationListsCreateSamples'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationSamplesResponse'
          description: Image Augmentation Samples generation has been successfully
            requested
          headers:
            Location:
              description: URL that can be polled to check the status of the operation.
              schema:
                type: string
      summary: Requests the creation of sample augmentations based on the augmentation
        list passed in.
      tags:
      - images
      x-versionadded: v2.27
  /api/v2/imageAugmentationOptions/{projectId}/:
    get:
      description: Augmentation list of all available transformations that are supported
        in the system.
      operationId: imageAugmentationOptions_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationOptionsResponse'
          description: Augmentation list object
      summary: Augmentation list of all available transformations that are supported
        in the system.
      tags:
      - images
      x-versionadded: v2.23
  /api/v2/imageAugmentationSamples/:
    post:
      description: (Deprecated in v2.28) This endpoint will schedule a job to augment
        the specified images from a project's dataset and return a link to monitor
        the status of the job, as well as a link to retrieve the resulting augmented
        images.
      operationId: imageAugmentationSamples_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageAugmentationSamplesRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationSamplesResponse'
          description: Image Augmentation Samples generation has been successfully
            requested
          headers:
            Location:
              description: URL that can be polled to check the status of the operation.
              schema:
                type: string
      summary: (Deprecated in v2.28) Requests the creation of sample augmentations
        based on the augmentation list parameters passed in. This route is being deprecated
        please use `POST /imageAugmentationLists/<augmentationId>/samples` route instead.
      tags:
      - images
      x-versionadded: v2.23
  /api/v2/imageAugmentationSamples/{samplesId}/:
    get:
      description: (Deprecated in v2.28) Retrieve previously generated Augmentation
        Samples. This route is being deprecated please use `GET /imageAugmentationLists/<augmentationId>/samples`
        route instead.
      operationId: imageAugmentationSamples_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Id of the augmentation sample
        in: path
        name: samplesId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationRetrieveSamplesResponse'
          description: ''
        '404':
          description: Augmentation Samples not found
      summary: (Deprecated in v2.28) Retrieve previously generated Augmentation Samples.
        This route is being deprecated please use `GET /imageAugmentationLists/<augmentationId>/samples`
        route instead.
      tags:
      - images
      x-versionadded: v2.23
  /api/v2/insights/featureEffects/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsFeatureEffects_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeFeatureEffectsRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of Feature Effects with an optional data slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/featureEffects/models/{entityId}/:
    get:
      description: List of paginated Feature Effects insights.
      operationId: insightsFeatureEffectsModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: true
        schema:
          enum:
          - validation
          - training
          - backtest_0
          - backtest_1
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          - holdout
          - backtest_0_training
          - backtest_1_training
          - backtest_2_training
          - backtest_3_training
          - backtest_4_training
          - backtest_5_training
          - backtest_6_training
          - backtest_7_training
          - backtest_8_training
          - backtest_9_training
          - backtest_10_training
          - backtest_11_training
          - backtest_12_training
          - backtest_13_training
          - backtest_14_training
          - backtest_15_training
          - backtest_16_training
          - backtest_17_training
          - backtest_18_training
          - backtest_19_training
          - backtest_20_training
          - holdout_training
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveFeatureEffectsPaginatedResponse'
          description: Retrieves a model's Feature Effects, either for the specified
            data_slice_id or, if not specified, for all slices in the original data
            partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated Feature Effects insights.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/featureImpact/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsFeatureImpact_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeFeatureImpactRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of Feature Impact with an optional data slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/featureImpact/models/{entityId}/:
    get:
      description: List of paginated Feature Impact insights.
      operationId: insightsFeatureImpactModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - training
          - backtest_2_training
          - backtest_3_training
          - backtest_4_training
          - backtest_5_training
          - backtest_6_training
          - backtest_7_training
          - backtest_8_training
          - backtest_9_training
          - backtest_10_training
          - backtest_11_training
          - backtest_12_training
          - backtest_13_training
          - backtest_14_training
          - backtest_15_training
          - backtest_16_training
          - backtest_17_training
          - backtest_18_training
          - backtest_19_training
          - backtest_20_training
          - backtest_1_training
          - holdout_training
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveFeatureImpactPaginatedResponse'
          description: Retrieves a model's Feature Impact, either for the specified
            data_slice_id or, if not specified, for all slices in the original data
            partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated Feature Impact insights.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/liftChart/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsLiftChart_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeLiftChartRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of Lift chart with an optional data slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/liftChart/models/{entityId}/:
    get:
      description: List of paginated Lift chart insights.
      operationId: insightsLiftChartModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the external dataset
        in: query
        name: externalDatasetId
        required: false
        schema:
          nullable: true
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLiftChartPaginatedResponse'
          description: Retrieves a model's Lift chart, either for the specified data_slice_id
            or, if not specified, for all slices in the original data partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated Lift chart insights.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/residuals/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsResiduals_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeResidualsRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of Residuals chart with an optional data slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/residuals/models/{entityId}/:
    get:
      description: List of paginated Residuals insights.
      operationId: insightsResidualsModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the external dataset
        in: query
        name: externalDatasetId
        required: false
        schema:
          nullable: true
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveResidualsPaginatedResponse'
          description: Retrieves a model's Residuals chart, either for the specified
            data_slice_id or, if not specified, for all slices in the original data
            partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated Residuals insights.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/rocCurve/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsRocCurve_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeRocCurveRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of ROC curve with an optional data slice.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/rocCurve/models/{entityId}/:
    get:
      description: List of paginated ROC curve insights.
      operationId: insightsRocCurveModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the external dataset
        in: query
        name: externalDatasetId
        required: false
        schema:
          nullable: true
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveRocCurvePaginatedResponse'
          description: Retrieves a model's ROC curve, either for the specified data_slice_id
            or, if not specified, for all slices in the original data partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated ROC curve insights.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/shapImpact/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsShapImpact_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeShapImpactRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of SHAP Impact with an optional data slice.
      tags:
      - insights
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables universal SHAP in DataRobot NextGen.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: UNIVERSAL_SHAP_IN_NEXTGEN
  /api/v2/insights/shapImpact/models/{entityId}/:
    get:
      description: List of paginated SHAP Impact insights.
      operationId: insightsShapImpactModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: Subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveShapImpactPaginatedResponse'
          description: Retrieves a model's SHAP impact chart, either for the specified
            data_slice_id or, if not specified, for all slices in the original data
            partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated SHAP Impact insights.
      tags:
      - insights
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables universal SHAP in DataRobot NextGen.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: UNIVERSAL_SHAP_IN_NEXTGEN
  /api/v2/insights/shapMatrix/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsShapMatrix_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeShapMatrixRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of SHAP Matrix with an optional data slice.
      tags:
      - insights
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables universal SHAP in DataRobot NextGen.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: UNIVERSAL_SHAP_IN_NEXTGEN
  /api/v2/insights/shapMatrix/models/{entityId}/:
    get:
      description: List of paginated SHAP Matrix insights.
      operationId: insightsShapMatrixModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the external dataset
        in: query
        name: externalDatasetId
        required: false
        schema:
          nullable: true
          type: string
      - description: The maximum number of preview rows to return.
        in: query
        name: predictionFilterRowCount
        required: false
        schema:
          minimum: 1
          type: integer
      - description: The number of percentile intervals to select from the total number
          of rows. This field will supersede predictionFilterRowCount if both are
          present.
        in: query
        name: predictionFilterPercentiles
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
      - description: The first operand to apply to filtered predictions.
        in: query
        name: predictionFilterOperandFirst
        required: false
        schema:
          type: number
      - description: The second operand to apply to filtered predictions.
        in: query
        name: predictionFilterOperandSecond
        required: false
        schema:
          type: number
      - description: The operator to apply to filtered predictions.
        in: query
        name: predictionFilterOperator
        required: false
        schema:
          enum:
          - eq
          - in
          - <
          - '>'
          - between
          - notBetween
          type: string
      - description: The maximum number of features to return for each preview.
        in: query
        name: featureFilterCount
        required: false
        schema:
          minimum: 1
          type: integer
      - description: The names of specific features to return for each preview.
        in: query
        name: featureFilterName
        required: false
        schema:
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveShapMatrixPaginatedResponse'
          description: Retrieves a model's SHAP Matrix chart, either for the specified
            data_slice_id or, if not specified, for all slices in the original data
            partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated SHAP Matrix insights.
      tags:
      - insights
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables universal SHAP in DataRobot NextGen.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: UNIVERSAL_SHAP_IN_NEXTGEN
  /api/v2/insights/shapPreview/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsShapPreview_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeShapMatrixRequest'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeInsightsResponse'
          description: The requested insights computation was accepted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unsupported project or model type, model not trained, or locked
            holdout
      summary: Request calculation of SHAP Preview with an optional data slice.
      tags:
      - insights
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables universal SHAP in DataRobot NextGen.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: UNIVERSAL_SHAP_IN_NEXTGEN
  /api/v2/insights/shapPreview/models/{entityId}/:
    get:
      description: List of paginated SHAP Preview insights.
      operationId: insightsShapPreviewModels_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 10
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          maximum: 1000000
          minimum: 0
          type: integer
      - description: ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          nullable: true
          type: string
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - training
          - validation
          - holdout
          - externalTestSet
          type: string
      - description: Return only insights without a data_slice_id
        in: query
        name: unslicedOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: ID of the external dataset
        in: query
        name: externalDatasetId
        required: false
        schema:
          nullable: true
          type: string
      - description: The maximum number of preview rows to return.
        in: query
        name: predictionFilterRowCount
        required: false
        schema:
          minimum: 1
          type: integer
      - description: The number of percentile intervals to select from the total number
          of rows. This field will supersede predictionFilterRowCount if both are
          present.
        in: query
        name: predictionFilterPercentiles
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
      - description: The first operand to apply to filtered predictions.
        in: query
        name: predictionFilterOperandFirst
        required: false
        schema:
          type: number
      - description: The second operand to apply to filtered predictions.
        in: query
        name: predictionFilterOperandSecond
        required: false
        schema:
          type: number
      - description: The operator to apply to filtered predictions.
        in: query
        name: predictionFilterOperator
        required: false
        schema:
          enum:
          - eq
          - in
          - <
          - '>'
          - between
          - notBetween
          type: string
      - description: The maximum number of features to return for each preview.
        in: query
        name: featureFilterCount
        required: false
        schema:
          minimum: 1
          type: integer
      - description: The names of specific features to return for each preview.
        in: query
        name: featureFilterName
        required: false
        schema:
          type: string
      - description: ID of the Model
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          - text/csv
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveShapPreviewPaginatedResponse'
            text/csv:
              schema:
                type: string
          description: Retrieves a model's SHAP Preview chart, either for the specified
            data_slice_id or, if not specified, for all slices in the original data
            partition.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: List of paginated SHAP Preview insights.
      tags:
      - insights
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables universal SHAP in DataRobot NextGen.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: UNIVERSAL_SHAP_IN_NEXTGEN
  /api/v2/mlops/portablePredictionServerImage/:
    get:
      description: Fetches the latest Portable Prediction Server (PPS) Docker image.
        The resulting image can be docker-loaded. Since the image can be quite large
        (14GB+) consider querying its metadata to check the image size in advance
        and content hash to verify the downloaded image afterwards. In some environments
        it can HTTP redirect to some other service (like S3 or GCP) using pre-signed
        URLs.
      operationId: mlopsPortablePredictionServerImage_list
      responses:
        '200':
          description: Download the latest available Portable Prediction Server (PPS)
            Docker image
        '302':
          description: Redirect to another service for more efficient content download
            using pre-signed URL
        '404':
          description: No PPS images found in the system
      summary: Downloads the latest Portable Prediction Server (PPS) Docker image
      tags:
      - mlops
      x-versionadded: v2.26
  /api/v2/mlops/portablePredictionServerImage/metadata/:
    get:
      description: Fetches currently active PPS Docker image metadata
      operationId: mlopsPortablePredictionServerImageMetadata_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PPSImageMetadataResponse'
          description: Available Portable Prediction Server (PPS) image metadata
        '404':
          description: No PPS images found in the system
      summary: Fetches currently active PPS Docker image metadata
      tags:
      - mlops
      x-versionadded: v2.26
  /api/v2/modelComplianceDocsInitializations/{entityId}/:
    get:
      description: Check if compliance documentation pre-processing is initialized
        for the current model. This is only required for custom models.
      operationId: modelComplianceDocsInitializations_retrieve
      parameters:
      - description: The ID of the model or model package the document corresponds
          to.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelComplianceDocsInitializationsResponse'
          description: Retrieve information about the status of the compliance documentation
            pre-preprocessing initialization.
        '404':
          description: Model not found.
      summary: Check if compliance documentation pre-processing is initialized for
        the model
      tags:
      - documentation
      x-versionadded: v2.27
    post:
      description: Initialize compliance documentation pre-processing for the current
        model. This route must be called before generating documentation for a custom
        model.
      operationId: modelComplianceDocsInitializations_createOne
      parameters:
      - description: The ID of the model or model package the document corresponds
          to.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Empty'
      responses:
        '202':
          description: Job to initialize compliance documentation pre-processing successfully
            started.
          headers:
            Location:
              description: 'URL to poll for getting a status of the job: :http:get:`/api/v2/status/(statusId)/`'
              schema:
                type: string
        '404':
          description: Model not found.
        '422':
          description: Cannot prepare model for compliance document generation.
      summary: Initialize compliance documentation pre-processing for the model
      tags:
      - documentation
      x-versionadded: v2.27
  /api/v2/modelPackages/:
    get:
      description: Retrieve the list of model packages a user has access to.
      operationId: modelPackages_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: If specified, limit results to model packages for the model with
          the specified ID.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Return model packages similar to a given model package ID. If
          used, will only return model packages that match `target.name`, `target.type`,
          `target.classNames` (for classification models), `modelKind.isTimeSeries`,
          and `modelKind.isMultiseries` of the specified model package.
        in: query
        name: similarTo
        required: false
        schema:
          type: string
      - description: Can be used with similarTo to request similar model packages
          with the intent to use them as challenger models; for external model packages,
          instead of returning similar external model packages, similar DataRobot
          and Custom model packages will be retrieved.
        in: query
        name: forChallenger
        required: false
        schema:
          type: boolean
      - description: Provide a term to search for in package name, model name, or
          description
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: Prediction threshold used for binary classification models
        in: query
        name: predictionThreshold
        required: false
        schema:
          maximum: 1
          minimum: 0
          type: number
      - description: If specified, filter for either imported (true) or non-imported
          (false) model packages
        in: query
        name: imported
        required: false
        schema:
          type: boolean
      - description: Can be used to filter packages by what is supported by the prediction
          environment
        in: query
        name: predictionEnvironmentId
        required: false
        schema:
          type: string
      - description: Return models from the registry that match a specific format.
        in: query
        name: modelKind
        required: false
        schema:
          oneOf:
          - enum:
            - is_unsupervised_learning
            - is_time_series
            - is_multiseries
            - is_blender
            - is_anomaly_detection_model
            - is_feature_discovery
            - is_shap_supported_model
            - is_unsupervised_clustering
            - is_combined_model
            - is_unstructured
            type: string
          - items:
              enum:
              - is_unsupervised_learning
              - is_time_series
              - is_multiseries
              - is_blender
              - is_anomaly_detection_model
              - is_feature_discovery
              - is_shap_supported_model
              - is_unsupervised_clustering
              - is_combined_model
              - is_unstructured
              type: string
            type: array
      - description: If specified, filter model packages by the build status.
        in: query
        name: buildStatus
        required: false
        schema:
          enum:
          - inProgress
          - complete
          - failed
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageListResponse'
          description: ''
        '400':
          description: Request invalid, refer to messages for detail.
        '403':
          description: Either MMM Model Packages or New Model Registry are not enabled.
        '404':
          description: User permissions problem.
      summary: List model packages
      tags:
      - models
      x-versionadded: v2.23
  /api/v2/modelPackages/fromLeaderboard/:
    post:
      description: Create model package from a Leaderboard model.
      operationId: modelPackagesFromLeaderboard_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelPackageCreateFromLeaderboard'
      responses:
        '202':
          description: A job for building model package file was successfully submitted.
        '422':
          description: Unable to process the Model Package creation request.
      summary: Create model package from a Leaderboard model.
      tags:
      - models
      x-versionadded: v2.31
  /api/v2/modelPackages/fromLearningModel/:
    post:
      description: "Create model package from DataRobot model.\n\n.. minversion::\
        \ v2.31\n    DEPRECATED: please use the following route instead:\n    :http:post:`/api/v2/modelPackages/fromLeaderboard/`\n"
      operationId: modelPackagesFromLearningModel_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelPackageCreateFromLearningModel'
      responses:
        '201':
          description: ''
        '403':
          description: The user does not have permission to create a Model Package.
        '404':
          description: Either the model_id not exist or the user does not have permission
            to view the model and project.
        '422':
          description: Unable to process the Model Package creation request.
      summary: Create model package from DataRobot model.
      tags:
      - models
      x-versionadded: v2.26
  /api/v2/modelPackages/{modelPackageId}/:
    get:
      description: Retrieve info about a model package.
      operationId: modelPackages_retrieve
      parameters:
      - description: ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageRetrieveResponse'
          description: ''
        '404':
          description: Either the model package does not exist or the user does not
            have permission to view the model package.
      summary: Retrieve info about a model package.
      tags:
      - models
      x-versionadded: v2.23
  /api/v2/modelPackages/{modelPackageId}/archive/:
    post:
      description: (Deprecated in v2.32) Permanently archive a model package. It will
        no longer be able to be used in new deployments or replacement. It will not
        be accessible in the model package list api. It will only be accessible at
        the model package retrieve route for this model package.
      operationId: modelPackagesArchive_create
      parameters:
      - description: ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Archive a model package.
      tags:
      - models
      x-versionadded: v2.21
  /api/v2/modelPackages/{modelPackageId}/capabilities/:
    get:
      description: Retrieve the capabilities for the model package.
      operationId: modelPackagesCapabilities_list
      parameters:
      - description: ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageCapabilitiesRetrieveResponse'
          description: ''
      summary: Retrieve capabilities.
      tags:
      - models
      x-versionadded: v2.29
  /api/v2/modelPackages/{modelPackageId}/features/:
    get:
      description: Retrieve the feature list for given model package.
      operationId: modelPackagesFeatures_list
      parameters:
      - description: The number of features to skip, defaults to 0.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of features to return, defaults to 0.
        in: query
        name: limit
        required: true
        schema:
          default: 50
          minimum: 0
          type: integer
      - description: When True will return all raw features in the universe dataset
          associated with the deployment, and when False will return only those raw
          features used to make predictions on the deployment.
        in: query
        name: includeNonPredictionFeatures
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.20
      - description: When True, features returned will be filtered to those usable
          for segmented analysis.
        in: query
        name: forSegmentedAnalysis
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Case insensitive search against names of the deployment's features.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          type: string
        x-versionadded: v2.24
      - description: Sort order which will be applied to model package feature list.
          Prefix the attribute name with a dash to sort in descending order, e.g.
          "-name".
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - name
          - -name
          - importance
          - -importance
          - featureType
          - -featureType
          - dateFormat
          - -dateFormat
          - knownInAdvance
          - -knownInAdvance
          type: string
      - description: ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureListResponse'
          description: OK.
      summary: Retrieve feature list.
      tags:
      - models
      x-versionadded: v2.25
  /api/v2/modelPackages/{modelPackageId}/sharedRoles/:
    get:
      description: (Deprecated in v2.32) instead.Get a list of users, groups and organizations
        who have access to this model package and their roles on the model package.
      operationId: modelPackagesSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The model package's access control list.
        '404':
          description: Either the Model Package does not exist or the user does not
            have permissions to view the Model Package.
        '422':
          description: Both username and userId were specified
      summary: Get model package's access control list
      tags:
      - models
      x-versionadded: v2.21
  /api/v2/models/{modelId}/documentTextExtractionSampleDocuments/:
    get:
      description: Retrieve documents with computed document text extraction samples.
      operationId: modelsDocumentTextExtractionSampleDocuments_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The name of the feature to retrieve documents for.
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The document task to retrieve documents for.
        in: query
        name: documentTask
        required: false
        schema:
          enum:
          - DOCUMENT_TEXT_EXTRACTOR
          - TESSERACT_OCR
          type: string
      - description: Model Id
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTextExtractionSamplesRetrieveDocumentsResponse'
          description: Documents with computed document text extraction samples.
      summary: Retrieve documents with computed document text extraction samples.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/models/{modelId}/documentTextExtractionSamplePages/:
    get:
      description: Retrieve document pages with recognized text lines and bounding
        boxes enclosing the text lines.
      operationId: modelsDocumentTextExtractionSamplePages_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The name of the feature.
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The index of the document within the dataset.
        in: query
        name: documentIndex
        required: false
        schema:
          type: integer
      - description: The document task to retrieve pages for.
        in: query
        name: documentTask
        required: false
        schema:
          enum:
          - DOCUMENT_TEXT_EXTRACTOR
          - TESSERACT_OCR
          type: string
      - description: Model Id
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTextExtractionSamplesRetrievePagesResponse'
          description: Document pages with recognized text lines and bounding boxes
            enclosing the text lines.
      summary: Retrieve document pages with recognized text lines and bounding boxes
        enclosing the text lines.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/models/{modelId}/documentTextExtractionSamples/:
    post:
      description: Requests the computation of document text extraction samples for
        the specified model.
      operationId: modelsDocumentTextExtractionSamples_create
      parameters:
      - description: Model Id
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTextExtractionSamplesComputeResponse'
          description: Document text extraction samples computation has been successfully
            requested.
          headers:
            Location:
              description: a url that can be polled to check the status of the job.
              schema:
                format: url
                type: string
        '422':
          description: 'Cannot compute document text extraction samples: if the insight
            was already computed for the model or there was another issue creating
            this job.'
      summary: Requests the computation of document text extraction samples for the
        specified model.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/multilabelInsights/{multilabelInsightsKey}/histogram/:
    get:
      description: Retrieve multicategorical feature histogram.
      operationId: multilabelInsightsHistogram_list
      parameters:
      - description: Key for multilabel insights, unique per project, feature, and
          EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
          or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
        in: path
        name: multilabelInsightsKey
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticategoricalHistogram'
          description: Multicategorical feature histogram.
      summary: Retrieve multicategorical feature histogram.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/:
    get:
      description: Get all label lists.
      operationId: multilabelInsightsPairwiseManualSelections_list
      parameters:
      - description: Key for multilabel insights, unique per project, feature, and
          EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
          or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
        in: path
        name: multilabelInsightsKey
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PairwiseManualSelectionsRetrieveResponse'
          description: All label lists
      summary: Get all label lists.
      tags:
      - insights
      x-versionadded: v2.27
    post:
      description: Save a list of manually selected labels for Feature Statistics
        matrix.
      operationId: multilabelInsightsPairwiseManualSelections_create
      parameters:
      - description: Key for multilabel insights, unique per project, feature, and
          EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
          or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
        in: path
        name: multilabelInsightsKey
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PairwiseManualSelectionCreatePayload'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PairwiseManualSelectionCreateResponse'
          description: Whether manually selected labels were saved successfully.
        '422':
          description: The manual selection name is already taken or another exception
            occurred.
      summary: Save a list of manually selected labels for Feature Statistics matrix.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/:
    delete:
      description: Delete label list.
      operationId: multilabelInsightsPairwiseManualSelections_delete
      parameters:
      - description: Key for multilabel insights, unique per project, feature, and
          EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
          or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
        in: path
        name: multilabelInsightsKey
        required: true
        schema:
          type: string
      - description: ID of the label set.
        in: path
        name: manualSelectionListId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PairwiseManualSelectionResponse'
          description: ID of the deleted label list.
      summary: Delete label list.
      tags:
      - insights
      x-versionadded: v2.27
    patch:
      description: Update label list's name.
      operationId: multilabelInsightsPairwiseManualSelections_patch
      parameters:
      - description: Key for multilabel insights, unique per project, feature, and
          EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
          or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
        in: path
        name: multilabelInsightsKey
        required: true
        schema:
          type: string
      - description: ID of the label set.
        in: path
        name: manualSelectionListId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PairwiseManualSelectionUpdateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PairwiseManualSelectionResponse'
          description: ID of the updated label list.
      summary: Update label list's name.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseStatistics/:
    get:
      description: 'Retrieve multilabel specific pairwise label statistics for the
        given multilabel insights key: correlation, joint probability and conditional
        probability.'
      operationId: multilabelInsightsPairwiseStatistics_list
      parameters:
      - description: Type of pairwise statistic.
        in: query
        name: statisticType
        required: true
        schema:
          enum:
          - conditionalProbability
          - correlation
          - jointProbability
          type: string
      - description: Key for multilabel insights, unique per project, feature, and
          EDA stage. The most recent key can be retrieved via :http:get:`/api/v2/projects/(projectId)/features/`
          or :http:get:`/api/v2/projects/(projectId)/features/(featurename:featureName)/`
        in: path
        name: multilabelInsightsKey
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PairwiseStatisticsResponse'
          description: Pairwise label statistics.
      summary: Retrieve pairwise statistics for the given multilabel insights key.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/notificationChannelTemplates/:
    get:
      description: List the notification channel template according to the query.
      operationId: notificationChannelTemplates_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Only return the notification channels whose names contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelTemplatesListResponse'
          description: Notification channel templates listed successfully.
      summary: List notification channel templates
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    post:
      description: Create a new notification channel tempate.
      operationId: notificationChannelTemplates_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelTemplateCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelTemplateResponse'
          description: Notification channel template created successfully.
      summary: Create notification channel template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/notificationChannelTemplates/{channelId}/:
    delete:
      description: Delete the notification channel template.
      operationId: notificationChannelTemplates_delete
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Notification channel template deleted successfully.
      summary: Delete notification channel template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    get:
      description: Retrieve the notification channel template.
      operationId: notificationChannelTemplates_retrieve
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelTemplateResponse'
          description: Notification channel template retrieved successfully.
      summary: Retrieve notification template channel
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
    put:
      description: Update the notification channel template.
      operationId: notificationChannelTemplates_put
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelWithDREntityUpdate'
      responses:
        '204':
          description: Notification channel template updated successfully.
        '400':
          description: Email verification code is invalid.
      summary: Update notification channel template
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/notificationChannelTemplates/{channelId}/policyTemplates/:
    get:
      description: Retrieve list of all policy templates that are using this channel
        and are visible for user
      operationId: notificationChannelTemplatesPolicyTemplates_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelTemplateRelatedPolicyTemplateListResponse'
          description: List of all policy templates that are using this channel and
            are visible for user
      summary: Retrieve list of all policy templates that are using this channel and
        are visible for user
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/notificationChannelTemplates/{channelId}/relatedPolicies/:
    get:
      description: Retrieve list of all policies that are created from this template
        and are visible for user
      operationId: notificationChannelTemplatesRelatedPolicies_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelTemplateRelatedPoliciesListResponse'
          description: List of all policies that are created from this template and
            are visible for user
      summary: Retrieve list of all policies that are created from this template and
        are visible for user
      tags:
      - notifications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables notification configuration for deployments.
        enabled_by_default: true
        maturity: GA_ALL
        name: MMM_NOTIFICATION_CONFIGURATION
      x-versionadded: v2.33
  /api/v2/notificationChannelTemplates/{channelId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this channel template and their roles on the channel template.
      operationId: notificationChannelTemplatesSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The channel template's access control list.
        '404':
          description: Either the channel template does not exist or the user does
            not have permissions to view the channel template.
        '422':
          description: Both username and userId were specified
      summary: Get channel template's access control list
      tags:
      - notifications
      x-versionadded: v2.33
    patch:
      description: Set roles for users on this channel template.
      operationId: notificationChannelTemplatesSharedRoles_patchMany
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the channel template without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update channel template's controls
      tags:
      - notifications
      x-versionadded: v2.33
  /api/v2/notificationChannels/:
    get:
      description: List the notification channels according to the query.
      operationId: notificationChannels_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Only return the notification channels whose names contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelsListResponse'
          description: Notification channels listed successfully.
      summary: List notification channels
      tags:
      - notifications
      x-versionadded: v2.20
    post:
      description: Create a new notification channel.
      operationId: notificationChannels_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelResponse'
          description: Notification channel created successfully.
      summary: Create notification channel
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationChannels/{channelId}/:
    delete:
      description: Delete the notification channel.
      operationId: notificationChannels_delete
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Notification channel deleted successfully.
      summary: Delete notification channel
      tags:
      - notifications
      x-versionadded: v2.20
    get:
      description: Retrieve the notification channel.
      operationId: notificationChannels_retrieve
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannelResponse'
          description: Notification channel retrieved successfully.
      summary: Retrieve notification channel
      tags:
      - notifications
      x-versionadded: v2.20
    put:
      description: Update the notification channel.
      operationId: notificationChannels_put
      parameters:
      - description: The id of the notification channel.
        in: path
        name: channelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelUpdate'
      responses:
        '204':
          description: Notification channel updated successfully.
        '400':
          description: Email verification code is invalid.
      summary: Update notification channel
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationEmailChannelVerification/:
    post:
      description: Sending a 6 digit verification code to user's email
      operationId: notificationEmailChannelVerification_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationEmailChannelVerification'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationEmailChannelVerificationResponse'
          description: ''
      summary: Sending a 6 digit verification code to user's email
      tags:
      - notifications
      x-versionadded: v2.21
  /api/v2/notificationEmailChannelVerificationStatus/:
    post:
      description: Retrieve the status of whether admin enter code correctly
      operationId: notificationEmailChannelVerificationStatus_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationEmailChannelVerificationStatus'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationEmailChannelVerificationStatusResponse'
          description: ''
      summary: Retrieve the status of whether admin enter code correctly
      tags:
      - notifications
      x-versionadded: v2.21
  /api/v2/notificationEvents/:
    get:
      description: List event types and groups the user can include in notification
        policies. Events and groups are filtered by user permissions and event properties.
        It is not a complete list of all defined events; instead, it is a list of
        the events available to the user.
      operationId: notificationEvents_list
      parameters:
      - description: Type of related entity.
        in: query
        name: relatedEntityType
        required: false
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationEventListResponse'
          description: Event types and groups selectable for notification policies
      summary: List event types and groups the user can include in notification policies.
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationLogs/:
    get:
      description: List the notification logs that correspond to provided conditions.
        Default ordering is desc by notification log timestamp
      operationId: notificationLogs_list
      parameters:
      - description: The number of records to skip over. Default 0
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return. Default to 100, minimum to 1,
          maximum to 1000
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The id of the policy to filter notification logs
        in: query
        name: policyId
        required: false
        schema:
          type: string
      - description: The id of the channel to filter notification logs
        in: query
        name: channelId
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLogListResponse'
          description: ''
      summary: List the notification logs
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationPolicies/:
    get:
      description: List the notification policies that satisfy the query condition.
      operationId: notificationPolicies_list
      parameters:
      - description: How many notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Return policies with this channel.
        in: query
        name: channelId
        required: false
        schema:
          type: string
      - description: Only return the notification channels whose names contain the
          given substring.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: Return policies with this event group.
        in: query
        name: eventGroup
        required: false
        schema:
          enum:
          - secure_config.all
          - comment.all
          - dataset.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - inference_endpoints.health
          - model_deployments.management_agent
          - model_deployments.management_agent_health
          - prediction_request.all
          - challenger_management.all
          - challenger_replay.all
          - model_deployments.all
          - project.all
          - perma_delete_project.all
          - users_delete.all
          - applications.all
          - model_version.stage_transitions
          - model_version.all
          - batch_predictions.all
          - change_requests.all
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPoliciesListResponse'
          description: Notification policies listed successfully.
      summary: List notification policies
      tags:
      - notifications
      x-versionadded: v2.20
    post:
      description: Create a new notification policy.
      operationId: notificationPolicies_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPolicyCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPolicyResponse'
          description: Notification policy created successfully.
      summary: Create notification policy
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationPolicies/{policyId}/:
    delete:
      description: Delete the notification policy.
      operationId: notificationPolicies_delete
      parameters:
      - description: The id of the notification policy
        in: path
        name: policyId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Notification policy deleted successfully.
      summary: Delete notification policy
      tags:
      - notifications
      x-versionadded: v2.20
    get:
      description: Retrieve the notification policy.
      operationId: notificationPolicies_retrieve
      parameters:
      - description: The id of the notification policy
        in: path
        name: policyId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPolicyResponse'
          description: Notification policy retrieved successfully.
      summary: Retrieve notification policy
      tags:
      - notifications
      x-versionadded: v2.20
    put:
      description: Update the notification policy.
      operationId: notificationPolicies_put
      parameters:
      - description: The id of the notification policy
        in: path
        name: policyId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPolicyUpdate'
      responses:
        '204':
          description: Notification policy updated successfully.
      summary: Update notification policy
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationPolicyMutes/:
    get:
      description: List the ignored notifications filtered by orgId if provided
      operationId: notificationPolicyMutes_list
      parameters:
      - description: The number of records to skip over. Default 0
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return. Default to 100, minimum to 1,
          maximum to 1000
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The id of the entity to filter
        in: query
        name: entityId
        required: false
        schema:
          type: string
      - description: The id of the organization that ignored notifications relate
          to
        in: query
        name: orgId
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPolicyMuteListResponse'
          description: ''
      summary: List the ignored notifications filtered by orgId if provided
      tags:
      - notifications
      x-versionadded: v2.20
    post:
      description: Create a new ignored notification
      operationId: notificationPolicyMutes_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPolicyMuteCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPolicyMuteResponse'
          description: ''
      summary: Create a new ignored notification
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationPolicyMutes/{muteId}/:
    delete:
      description: Delete the existing notification policy mute
      operationId: notificationPolicyMutes_delete
      parameters:
      - description: The id of the notification policy mute to delete
        in: path
        name: muteId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Delete the existing notification policy mute
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationWebhookChannelTests/:
    post:
      description: Test the webhook notification channel.
      operationId: notificationWebhookChannelTests_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationWebhookChannelTestCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationWebhookChannelTestId'
          description: The test for the webhook notification channel was created.
      summary: Test webhook notification channel
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationWebhookChannelTests/{notificationId}/:
    get:
      description: Retrieve the status of the notification channel test.
      operationId: notificationWebhookChannelTests_retrieve
      parameters:
      - description: The identifier of the notification.
        in: path
        name: notificationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationWebhookChannelStatusResponse'
          description: The notification status was retrieved.
      summary: Retrieve status of notification channel test
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notifications/:
    post:
      description: Resends the notification
      operationId: notifications_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationResend'
      responses:
        '200':
          description: ''
      summary: Resends the notification
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/organizations/:
    get:
      description: List organizations available in the system.
      operationId: organizations_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Query for organizations with these ids
        in: query
        name: id
        required: false
        schema:
          items:
            type: string
          type: array
        x-versionadded: v2.31
      - description: Only return the organizations whose names contain the given substring.
        in: query
        name: namePart
        required: false
        schema:
          default: ''
          type: string
      - description: Allows the ability to retrieve deleted organizations.
        in: query
        name: includeDeleted
        required: true
        schema:
          default: false
          type: boolean
      - description: Allows the ability to retrieve deleted and permadeleted organizations.
        in: query
        name: includePermadeleted
        required: true
        schema:
          default: false
          type: boolean
      - description: Allows the ability to retrieve only deleted and permadeleted
          organizations.
        in: query
        name: deletedOnly
        required: true
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationListResponse'
          description: ''
      summary: List organizations
      tags:
      - user_management
      x-versionadded: v2.0
  /api/v2/organizations/{organizationId}/:
    get:
      description: Retrieve the organization details.
      operationId: organizations_retrieve
      parameters:
      - description: Organization ID
        in: path
        name: organizationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationRetrieve'
          description: ''
      summary: Retrieve organization
      tags:
      - user_management
      x-versionadded: v2.0
  /api/v2/organizations/{organizationId}/jobs/:
    get:
      description: List currently running jobs belonging to this organization.
      operationId: organizationsJobs_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Organization ID
        in: path
        name: organizationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationJobListResponse'
          description: ''
      summary: List organization jobs
      tags:
      - user_management
      x-versionadded: v2.0
  /api/v2/organizations/{organizationId}/users/:
    get:
      description: List memberships in this organization.
      operationId: organizationsUsers_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Organization ID
        in: path
        name: organizationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationUserListResponse'
          description: ''
      summary: List organization users
      tags:
      - user_management
      x-versionadded: v2.0
    post:
      description: Add user to an existing organization. A user can only be part of
        one organization at a time, so they will be removed from their previous organization
        if needed. Onlya system admin can move a user from one organization to another.
      operationId: organizationsUsers_create
      parameters:
      - description: Organization ID
        in: path
        name: organizationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationUser'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationUserCreatedResponse'
          description: ''
        '422':
          description: Invalid data
      summary: Add user to an existing organization.
      tags:
      - user_management
      x-versionadded: v2.0
  /api/v2/organizations/{organizationId}/users/{userId}/:
    get:
      description: Retrieve the user from this organization.
      operationId: organizationsUsers_retrieve
      parameters:
      - description: The organization the user is in
        in: path
        name: organizationId
        required: true
        schema:
          type: string
      - description: The user ID
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationUserResponse'
          description: ''
      summary: Retrieve user from organization
      tags:
      - user_management
      x-versionadded: v2.0
    patch:
      description: Patch organization's user. Only system or the organization admin
        can perform this operation.
      operationId: organizationsUsers_patch
      parameters:
      - description: The organization the user is in
        in: path
        name: organizationId
        required: true
        schema:
          type: string
      - description: The user ID
        in: path
        name: userId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationUserPatch'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
          description: ''
        '403':
          description: Invalid Permissions
        '422':
          description: Invalid data
      summary: Patch organization's user
      tags:
      - user_management
      x-versionadded: v2.0
  /api/v2/predictionServers/:
    get:
      description: List prediction servers available for a user.
      operationId: predictionServers_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionServerListResponse'
          description: ''
      summary: List prediction servers.
      tags:
      - deployments
      x-versionadded: v2.17
  /api/v2/presentationApplications/:
    post:
      description: Create an application. Note that the number of active applications
        users can have at the same time is limited.
      operationId: presentationApplications_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresentationApplicationCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
          description: ''
        '202':
          description: Creation has successfully started. See the Location header.
        '403':
          description: User does not have permission to launch application of provided
            type.
        '404':
          description: No app type matching the specified identifier found or user
            does not have permissions to access to this app type.
        '422':
          description: Application could not be created with the given input.
      summary: Create a presentation application
      tags:
      - applications
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables the Presentation template in No-Code AI Apps, which creates
          applications to organize, explore, and present model insights.
        enabled_by_default: false
        maturity: PUBLIC_PREVIEW
        name: APPSBUILDER_PRESENTATION_APP
  /api/v2/projectCleanupJobs/:
    get:
      description: Get async status of the project permadelete job
      operationId: projectCleanupJobs_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectNukeJobListStatus'
          description: Permadelete Job Status with details per project
      summary: Retrieve Project Permadelete job status
      tags:
      - projects
      x-versionadded: v2.26
    post:
      description: Add list of projects to permadelete and returns async status
      operationId: projectCleanupJobs_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectNuke'
      responses:
        '202':
          description: Location URL to check permadelete status per project
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Schedule Project Permadelete Job
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/projectCleanupJobs/{statusId}/:
    delete:
      description: Stop permadelete job, if possible
      operationId: projectCleanupJobs_delete
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Cancel Scheduled Project Permadelete Job
      tags:
      - projects
      x-versionadded: v2.26
    get:
      description: Get async status of the project permadelete job
      operationId: projectCleanupJobs_retrieve
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectNukeJobStatus'
          description: Permadelete Job Status with details per project
      summary: Retrieve Project Permadelete job status
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/projectCleanupJobs/{statusId}/download/:
    get:
      description: Get a file containing a per-project report of permanent deletion.
      operationId: projectCleanupJobsDownload_list
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectNukeJobStatus'
          description: JSON-formatted project permadeletion report.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ('attachment;filename="project_permadeletion_<statusId>.json"').
              schema:
                type: string
      summary: Download a projects permadeletion report.
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/projectCleanupJobs/{statusId}/summary/:
    get:
      description: Get number of projects whose deletion finished in particular state
      operationId: projectCleanupJobsSummary_list
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectNukeJobStatusSummary'
          description: Project permanent deletion job status to occurrence count
      summary: Get a projects cleanup jobs summary.
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/projectClones/:
    post:
      description: "\n    Create a clone of an existing project.\n\n    The resultant\
        \ project will begin the initial exploratory\n    data analysis and will be\
        \ ready to set the target of the new project shortly.\n    "
      operationId: projectClones_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectClone'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectCreateResponse'
          description: Project cloning has successfully started.  See the Location
            header.
      summary: Clone a project
      tags:
      - projects
      x-versionadded: v2.19
  /api/v2/projects/:
    get:
      description: List all available projects.
      operationId: projects_list
      parameters:
      - description: if provided will filter returned projects for projects with matching
          names
        in: query
        name: projectName
        required: false
        schema:
          type: string
      - description: if provided will filter returned projects with matching project
          IDs
        in: query
        name: projectId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
      - description: if provided will order the results by this field
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - projectName
          - -projectName
          type: string
      - description: Return only feature discovery projects
        in: query
        name: featureDiscovery
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.23
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 1000
          maximum: 1000
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProjectDetailsResponse'
                type: array
          description: The list of projects
      summary: List projects
      tags:
      - projects
      x-versionadded: v2.0
    post:
      description: Create a new project.
      operationId: projects_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectCreateResponse'
          description: Creation has successfully started.  See the Location header.
        '403':
          description: User does not have permission to use specified dataset item
            for project.
        '404':
          description: The dataset item with the given ID or version ID is not found.
        '422':
          description: Ingest not yet completed.
      summary: Create project.
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/:
    delete:
      description: Delete a project
      operationId: projects_delete
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The project has been successfully deleted.
        '409':
          description: The project is in use and cannot be deleted.
      summary: Delete a project
      tags:
      - projects
      x-versionadded: v2.0
    get:
      description: Look up a particular project
      operationId: projects_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectRetrieveResponse'
          description: The project.
      summary: Get project.
      tags:
      - projects
      x-versionadded: v2.0
    patch:
      description: "Change project name, worker count, or unlock the holdout.\n  \
        \  If any of the optional json arguments are not provided,\n    that aspect\
        \ of the project will not be altered."
      operationId: projects_patch
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectUpdate'
      responses:
        '200':
          description: The project was successfully updated
      summary: Update project
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/accessControl/:
    get:
      description: Get a list of users who have access to this project and their roles
        on the project.
      operationId: projectsAccessControl_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Optional, only return the access control information for a user
          with this username.
        in: query
        name: username
        required: false
        schema:
          type: string
      - description: Optional, only return the access control information for a user
          with this user ID.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListResponse'
          description: The project's access control list.
        '404':
          description: Either the project does not exist or the user does not have
            permissions to view the project.
        '422':
          description: Both username and userId were specified
      summary: Get project's access control list
      tags:
      - projects
      x-versionadded: v2.15
    patch:
      description: Set roles for users on this project.
      operationId: projectsAccessControl_patchMany
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingUpdateOrRemove'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the project without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update project's access controls
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/projects/{projectId}/aim/:
    patch:
      description: Start the data modeling process.
      operationId: configure_and_start_autopilot
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Aim'
      responses:
        '202':
          description: Autopilot has successfully started.  See the Location header.
      summary: Start modeling
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/anomalyAssessmentRecords/:
    get:
      description: Retrieve anomaly assessment records.
      operationId: projectsAnomalyAssessmentRecords_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The model ID to filter records by.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The backtest to filter records by.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data to filter records by.
        in: query
        name: source
        required: false
        schema:
          enum:
          - training
          - validation
          type: string
      - description: Can be specified for multiseries projects. The series id to filter
          records by.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAssessmentRecordsResponse'
          description: Retrieve anomaly assessment records.
        '404':
          description: No data found
        '422':
          description: Input parameters are invalid
      summary: Retrieve anomaly assessment records.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/:
    delete:
      description: Delete the anomaly assessment record.
      operationId: projectsAnomalyAssessmentRecords_delete
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The anomaly assessment record ID
        in: path
        name: recordId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Anomaly assessment record deleted.
        '404':
          description: Data was not found.
      summary: Delete the anomaly assessment record.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/explanations/:
    get:
      description: 'Retrieve anomaly assessment record.

        Two out of three parameters: `startDate`, `endDate` or `pointsCount` must
        be specified.'
      operationId: projectsAnomalyAssessmentRecordsExplanations_list
      parameters:
      - description: 'The start of the date range to return. Date should be in UTC
          format. For example: ``2019-08-01T00:00:00.000000Z``.'
        in: query
        name: startDate
        required: false
        schema:
          format: date-time
          type: string
      - description: 'The end of the date range to return, inclusive. Date should
          be in UTC format. For example: ``2020-01-01T00:00:00.000000Z``.'
        in: query
        name: endDate
        required: false
        schema:
          format: date-time
          type: string
      - description: Count of points to return.
        in: query
        name: pointsCount
        required: false
        schema:
          maximum: 5000
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The anomaly assessment record ID
        in: path
        name: recordId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAssessmentExplanationsResponse'
          description: Anomaly assessment record.
        '404':
          description: Data was not found.
        '422':
          description: Insight is not available.
      summary: Retrieve anomaly assessment record.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/predictionsPreview/:
    get:
      description: Retrieve predictions preview for the anomaly assessment record.
      operationId: projectsAnomalyAssessmentRecordsPredictionsPreview_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The anomaly assessment record ID
        in: path
        name: recordId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAssessmentPreviewResponse'
          description: Predictions preview for the anomaly assessment record.
        '404':
          description: Record not found.
        '422':
          description: Predictions preview is not available.
      summary: Retrieve predictions preview for the anomaly assessment record.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/autopilot/:
    post:
      description: Pause or unpause the autopilot for a project.
      operationId: projectsAutopilot_create
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Autopilot'
      responses:
        '202':
          description: Request received
      summary: Pause or unpause Autopilot
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/autopilots/:
    post:
      description: Start autopilot on provided featurelist.
      operationId: projectsAutopilots_create
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutopilotStart'
      responses:
        '201':
          description: Successfully started
        '422':
          description: Autopilot on this featurelist has already completed or is already
            in progress. This status code is also returned if target was not selected
            for specified project.
      summary: Start autopilot
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/batchTypeTransformFeatures/:
    post:
      description: Create multiple new features by changing the type of existing features.
      operationId: projectsBatchTypeTransformFeatures_create
      parameters:
      - description: The project to create the feature in.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchFeatureTransform'
      responses:
        '200':
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unable to process the request
      summary: Create multiple new features by changing the type of existing features.
      tags:
      - projects
      x-versionadded: v2.17
  /api/v2/projects/{projectId}/batchTypeTransformFeaturesResult/{jobId}/:
    get:
      description: Retrieve the result of a batch variable type transformation.
      operationId: projectsBatchTypeTransformFeaturesResult_retrieve
      parameters:
      - description: The project containing transformed features.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: ID of the batch variable type transformation job.
        in: path
        name: jobId
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchFeatureTransform'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchFeatureTransformRetrieveResponse'
          description: Names of successfully created features.
        '404':
          description: Could not find specified transformation report
      summary: Retrieve the result of a batch variable type transformation.
      tags:
      - projects
      x-versionadded: v2.17
  /api/v2/projects/{projectId}/biasMitigatedModels/:
    get:
      description: List of bias mitigated models for the selected project.
      operationId: projectsBiasMitigatedModels_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Retrieve a list of mitigated models for the parent model if specified.
          Otherwise retrieve a list of all mitigated models for the project.
        in: query
        name: parentModelId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiasMitigatedModelsListResponse'
          description: Returns Bias Mitigated models results.
      summary: List of bias mitigated models for the selected project.
      tags:
      - models
      x-versionadded: v2.29
    post:
      description: 'Add a request to the queue to train a model with bias mitigation
        applied.

        If the job has been previously submitted, the request will return the `jobId`
        of the previously submitted job. Use this `jobId` to check status of the previously
        submitted job.'
      operationId: projectsBiasMitigatedModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BiasMitigationModelCreate'
      responses:
        '202':
          description: The model training request has been successfully submitted.
            See Location header.
      summary: Add a request to the queue to train a model with bias mitigation applied.
      tags:
      - models
      x-versionadded: v2.29
  /api/v2/projects/{projectId}/biasMitigationFeatureInfo/:
    get:
      description: Get bias mitigation data quality information for a given projectId
        and featureName.
      operationId: projectsBiasMitigationFeatureInfo_list
      parameters:
      - description: Name of feature for mitigation info.
        in: query
        name: featureName
        required: true
        schema:
          maxLength: 500
          minLength: 1
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessagesInfo'
          description: Dictionary with one entry ("messages") with list of data quality
            information about a feature.
      summary: Get bias mitigation data quality information for a given projectId
        and featureName.
      tags:
      - models
      x-versionadded: v2.29
  /api/v2/projects/{projectId}/biasMitigationFeatureInfo/{featureName}/:
    post:
      description: Submit a job to create bias mitigation data quality information
        for a given projectId and featureName.
      operationId: projectsBiasMitigationFeatureInfo_createOne
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Name of feature for mitigation info.
        in: path
        name: featureName
        required: true
        schema:
          maxLength: 500
          minLength: 1
          type: string
      responses:
        '202':
          description: A URI of the newly submitted job in the "Location" header.
      summary: Submit a job to create bias mitigation data quality information for
        a given projectId and featureName.
      tags:
      - models
      x-versionadded: v2.29
  /api/v2/projects/{projectId}/biasVsAccuracyInsights/:
    get:
      description: Retrieve a list of Bias vs Accuracy insights for the model.
      operationId: projectsBiasVsAccuracyInsights_list
      parameters:
      - description: The metric to return model accuracy scores. Defaults to the optimization
          metric configured in project options.
        in: query
        name: accuracyMetric
        required: false
        schema:
          enum:
          - AUC
          - Weighted AUC
          - Area Under PR Curve
          - Weighted Area Under PR Curve
          - Kolmogorov-Smirnov
          - Weighted Kolmogorov-Smirnov
          - FVE Binomial
          - Weighted FVE Binomial
          - Gini Norm
          - Weighted Gini Norm
          - LogLoss
          - Weighted LogLoss
          - Max MCC
          - Weighted Max MCC
          - Rate@Top5%
          - Weighted Rate@Top5%
          - Rate@Top10%
          - Weighted Rate@Top10%
          - Rate@TopTenth%
          - RMSE
          - Weighted RMSE
          type: string
      - description: Name of the protected feature.
        in: query
        name: protectedFeature
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: The fairness metric used to calculate the fairness scores.
        in: query
        name: fairnessMetric
        required: false
        schema:
          oneOf:
          - enum:
            - proportionalParity
            - equalParity
            - favorableClassBalance
            - unfavorableClassBalance
            - trueUnfavorableRateParity
            - trueFavorableRateParity
            - favorablePredictiveValueParity
            - unfavorablePredictiveValueParity
            type: string
          - items:
              enum:
              - proportionalParity
              - equalParity
              - favorableClassBalance
              - unfavorableClassBalance
              - trueUnfavorableRateParity
              - trueFavorableRateParity
              - favorablePredictiveValueParity
              - unfavorablePredictiveValueParity
              type: string
            type: array
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiasVsAccuracyInsightRetrieve'
          description: Returns Bias vs Accuracy results.
      summary: List Bias vs Accuracy insights.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/blenderModels/:
    get:
      description: List all blenders in a project.
      operationId: projectsBlenderModels_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlenderListResponse'
          description: A list of all of the blenders in a project.
        '404':
          description: This resource does not exist.
      summary: List all blenders in a project.
      tags:
      - models
      x-versionadded: v2.5
    post:
      description: 'Create a blender from other models using a specified blender method.
        Note: Time Series projects only allow the following blender methods: "AVG",
        "MED", "FORECAST_DISTANCE_ENET", and "FORECAST_DISTANCE_AVG".'
      operationId: projectsBlenderModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlenderCreate'
      responses:
        '202':
          description: Model job successfully added to queue. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status of the job.
              schema:
                format: url
                type: string
        '404':
          description: This resource does not exist.
        '422':
          description: Unable to create a blender or request is not supported in this
            context.
      summary: Create a blender from other models using a specified blender method.
      tags:
      - models
      x-versionadded: v2.5
  /api/v2/projects/{projectId}/blenderModels/blendCheck/:
    post:
      description: Check if models can be blended.
      operationId: projectsBlenderModelsBlendCheck_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlenderCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlenderInfoRetrieveResponse'
          description: Information on whether models can be blended and why.
        '404':
          description: This resource does not exist.
        '422':
          description: Unable to process request.
      summary: Check if models can be blended.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/blenderModels/{modelId}/:
    get:
      description: Retrieve a blender. Blenders are a special type of models, so the
        response includes all attributes that would be in a response to :http:get:`/api/v2/projects/(projectId)/models/(modelId)/`
        as well as some additional ones.
      operationId: projectsBlenderModels_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlenderRetrieveResponse'
          description: The blender model.
        '404':
          description: Specified blender not found.
      summary: Retrieve a blender.
      tags:
      - models
      x-versionadded: v2.5
  /api/v2/projects/{projectId}/blueprints/:
    get:
      description: List appropriate blueprints for the project.
      operationId: projectsBlueprints_list
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BlueprintResponse'
                type: array
          description: The list of blueprints
      summary: List blueprints
      tags:
      - blueprints
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/blueprints/{blueprintId}/:
    get:
      description: Retrieve a blueprint by its ID.
      operationId: projectsBlueprints_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The blueprint ID.
        in: path
        name: blueprintId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlueprintResponse'
          description: A blueprint based on its blueprint ID.
        '404':
          description: This resource does not exist.
      summary: Retrieve a blueprint by its ID.
      tags:
      - blueprints
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintChart/:
    get:
      description: Retrieve a blueprint chart by blueprint id.
      operationId: projectsBlueprintsBlueprintChart_list
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The blueprint ID.
        in: path
        name: blueprintId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlueprintChartRetrieveResponse'
          description: A blueprint chart based on the blueprint id.
        '404':
          description: No blueprint data found.
      summary: Retrieve a blueprint chart by blueprint id.
      tags:
      - blueprints
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/:
    get:
      description: Retrieve blueprint tasks documentation.
      operationId: projectsBlueprintsBlueprintDocs_list
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The blueprint ID.
        in: path
        name: blueprintId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BlueprintListDocumentsResponse'
                type: array
          description: The task documentation for a blueprint.
        '404':
          description: Model document missing.
      summary: Retrieve blueprint tasks documentation.
      tags:
      - blueprints
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/blueprints/{blueprintId}/json/:
    get:
      description: Retrieve a blueprint json by its ID.
      operationId: projectsBlueprintsJson_list
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The blueprint ID.
        in: path
        name: blueprintId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlueprintJsonResponse'
          description: Blueprint json based on its blueprint ID.
        '404':
          description: This resource does not exist.
      summary: Retrieve the JSON representation of a datarobot blueprint.
      tags:
      - blueprints
      x-versionadded: v2.31
  /api/v2/projects/{projectId}/calendarEvents/:
    get:
      description: List available calendar events for the project.
      operationId: projectsCalendarEvents_list
      parameters:
      - description: The name of the series to retrieve specific series for. If specified,
          retrieves only series specific to the event and common events.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: The start of the date range to return, inclusive. If not specified,
          start date for the first calendar event will be used.
        in: query
        name: startDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The end of the date range to return, exclusive. If not specified,
          end date capturing the last calendar event will be used.
        in: query
        name: endDate
        required: false
        schema:
          format: date-time
          type: string
      - description: 'Optional (default: `0`), this many results will be skipped.'
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: 'Optional (default: `1000`), at most this many results will be
          returned.'
        in: query
        name: limit
        required: false
        schema:
          default: 1000
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEventsResponseQuery'
          description: A list of calendar events.
      summary: List available calendar events for the project.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/combinedModels/:
    get:
      description: "Retrieve all existing combined models for this project.\n.. note::\n\
        \n    To retrieve information on the segments for a combined model, retrieve\
        \ the combined model using :http:get:`/api/v2/projects/(projectId)/combinedModels/(combinedModelId)/`"
      operationId: projectsCombinedModels_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CombinedModelListResponse'
          description: ''
      summary: Retrieve all existing combined models for this project.
      tags:
      - models
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/:
    get:
      description: Retrieve an existing combined model. If available, contains information
        on which champion model is used for each segment.
      operationId: projectsCombinedModels_retrieve
      parameters:
      - description: The ID of the project.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of combined model.
        in: path
        name: combinedModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CombinedModelResponse'
          description: ''
      summary: Retrieve an existing combined model.
      tags:
      - models
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/segments/:
    get:
      description: Retrieve Combined Model segments info (name, related project &
        model details).
      operationId: projectsCombinedModelsSegments_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Case insensitive search against segment name.
        in: query
        name: searchSegmentName
        required: false
        schema:
          maxLength: 100
          type: string
        x-versionadded: v2.27
      - description: The ID of the project.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of combined model.
        in: path
        name: combinedModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CombinedModelSegmentsPaginatedResponse'
          description: ''
      summary: Retrieve Combined Model segments info.
      tags:
      - models
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/segments/download/:
    get:
      description: Download Combined Model segments info (name, related project &
        model details) as a CSV.
      operationId: projectsCombinedModelsSegmentsDownload_list
      parameters:
      - description: The ID of the project.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of combined model.
        in: path
        name: combinedModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            text/csv:
              schema:
                type: string
          description: ''
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download.
              schema:
                type: string
      summary: Download Combined Model segments info.
      tags:
      - models
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/crossSeriesProperties/:
    post:
      description: 'Validate columns for potential use as the group-by column for
        cross-series functionality.


        The group-by column is an optional setting that indicates how to further splitseries
        into related groups. For example, if each series represents sales of an individual
        product, the group-by column could be the product category, e.g., "clothing"
        or "sports equipment".'
      operationId: projectsCrossSeriesProperties_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrossSeriesGroupByColumnValidatePayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossSeriesGroupByColumnValidateResponse'
          description: Cross-series group-by column validation job was successfully
            submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Validate columns for potential use as the group-by column for cross-series
        functionality.
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/projects/{projectId}/dataSlices/:
    get:
      description: Returns a paginated list of data slices for the given project ID.
      operationId: projectsDataSlices_list
      parameters:
      - description: The numbers of items to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: The number of items to skip before starting to collect the result
          set.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSlicesListAllSlicesResponse'
          description: List of data slices for the project was successfully retrieved.
      summary: List paginated Data Slices.
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/projects/{projectId}/datetimeModels/:
    get:
      description: List all the models from a datetime partitioned project.
      operationId: projectsDatetimeModels_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: the ID of the bulk model operation. If specified, only models
          submitted in scope of this operation will be shown.
        in: query
        name: bulkOperationId
        required: false
        schema:
          type: string
        x-versionadded: v2.25
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeModelsResponse'
          description: The datetime partitioned project's models
      summary: List datetime partitioned project models
      tags:
      - models
      x-versionadded: v2.6
    post:
      description: 'Train a new datetime model.


        All durations and datetimes should be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.'
      operationId: projectsDatetimeModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainDatetimeModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeModelSubmissionResponse'
          description: The model has been successfully submitted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: There was an error submitting the specified job. See the `message`
            field for more details.
      summary: Train a new datetime model.
      tags:
      - models
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/datetimeModels/fromModel/:
    post:
      description: 'Retrain an existing datetime model using a new training period
        for the model training set (with optional time window sampling) or different
        feature list.


        All durations and datetimes should be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.


        Note that only one of `trainingDuration` or `trainingRowCount` or `trainingStartDate`
        and `trainingEndDate` should be specified. If `trainingStartDate` and `trainingEndDate`
        are specified, the source model must be frozen.'
      operationId: projectsDatetimeModelsFromModel_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrainDatetimeModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeModelSubmissionResponse'
          description: Retrain an existing datetime model using a new sample size
            and/or feature list.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have permissions to manage models.
        '404':
          description: Model with specified `modelId` doesn't exist, or user does
            not have access to the project.
        '422':
          description: Model with specified `modelId` is deprecated, or it doesn't
            support retraining with specified parameters.
      summary: Retrain an existing datetime model with specified parameters.
      tags:
      - models
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/:
    get:
      description: 'Look up a particular datetime model

        All durations and datetimes are specified in accordance with :ref:`timestamp
        and duration formatting rules <time_format>`.'
      operationId: projectsDatetimeModels_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeModelDetailsResponse'
          description: Datetime model
      summary: Get datetime model
      tags:
      - models
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/:
    get:
      description: Retrieve the data for the Accuracy over Time plots.
      operationId: projectsDatetimeModelsAccuracyOverTimePlots_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided an average plot for the first 1000
          series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: Retrieve plots for a specific backtest (use the backtest index
          starting from zero) or `holdout`. If not specified the first backtest (backtest
          index 0) will be used.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data for the backtest/holdout.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - training
          - validation
          type: string
      - description: Forecast distance to retrieve the data for. If not specified,
          the first forecast distance for this project will be used. Forecast distance
          specifies the number of time steps between the predicted point and the origin
          point. Only available for time series supervised projects.
        in: query
        name: forecastDistance
        required: false
        schema:
          minimum: 0
          type: integer
      - description: Specifying at which resolution the data should be binned. If
          not specified, optimal resolution will be used to build chart data with
          number of bins <= `maxBinSize`
        in: query
        name: resolution
        required: false
        schema:
          enum:
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
      - description: Specifies the maximum number of bins for the retrieval.
        in: query
        name: maxBinSize
        required: false
        schema:
          default: 500
          maximum: 1000
          minimum: 1
          type: integer
      - description: The start of the date range to return. If not specified, start
          date for requested plots will be used.
        in: query
        name: startDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The end of the date range to return. If not specified, end date
          for requested plots will be used.
        in: query
        name: endDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccuracyOverTimePlotsDataResponse'
          description: Accuracy over Time plots data
        '404':
          description: Accuracy over Time plots data was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the data for the Accuracy over Time plots.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/metadata/:
    get:
      description: Retrieve the metadata for the Accuracy over Time insights.
      operationId: projectsDatetimeModelsAccuracyOverTimePlotsMetadata_list
      parameters:
      - description: Forecast distance to retrieve the data for. If not specified,
          the first forecast distance for this project will be used. Forecast distance
          specifies the number of time steps between the predicted point and the origin
          point. Only available for time series supervised projects.
        in: query
        name: forecastDistance
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided a metadata of average plot for the
          first 1000 series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
        x-versionadded: '2.28'
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccuracyOverTimePlotsMetadataResponse'
          description: Accuracy over Time insight metadata
        '404':
          description: Accuracy over Time insight metadata was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the metadata for the Accuracy over Time insights.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/preview/:
    get:
      description: Retrieve the preview for the Accuracy over Time plots.
      operationId: projectsDatetimeModelsAccuracyOverTimePlotsPreview_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided an average plot for the first 1000
          series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: Retrieve plots for a specific backtest (use the backtest index
          starting from zero) or `holdout`. If not specified the first backtest (backtest
          index 0) will be used.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data for the backtest/holdout.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - training
          - validation
          type: string
      - description: Forecast distance to retrieve the data for. If not specified,
          the first forecast distance for this project will be used. Forecast distance
          specifies the number of time steps between the predicted point and the origin
          point. Only available for time series supervised projects.
        in: query
        name: forecastDistance
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeTrendPlotsPreviewResponse'
          description: Accuracy over Time plots preview
        '404':
          description: Accuracy over Time plots preview was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the preview for the Accuracy over Time plots.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/:
    get:
      description: Retrieve the data for the Anomaly over Time plots.
      operationId: projectsDatetimeModelsAnomalyOverTimePlots_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided an average plot for the first 1000
          series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: Retrieve plots for a specific backtest (use the backtest index
          starting from zero) or `holdout`. If not specified the first backtest (backtest
          index 0) will be used.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data for the backtest/holdout.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - training
          - validation
          type: string
      - description: Specifying at which resolution the data should be binned. If
          not specified, optimal resolution will be used to build chart data with
          number of bins <= `maxBinSize`
        in: query
        name: resolution
        required: false
        schema:
          enum:
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
      - description: Specifies the maximum number of bins for the retrieval.
        in: query
        name: maxBinSize
        required: false
        schema:
          default: 500
          maximum: 1000
          minimum: 1
          type: integer
      - description: The start of the date range to return. If not specified, start
          date for requested plots will be used.
        in: query
        name: startDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The end of the date range to return. If not specified, end date
          for requested plots will be used.
        in: query
        name: endDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyOverTimePlotsDataResponse'
          description: Anomaly over Time plots data
        '404':
          description: Anomaly over Time plots data was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the data for the Anomaly over Time plots.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/metadata/:
    get:
      description: Retrieve the metadata for the Anomaly over Time insights.
      operationId: projectsDatetimeModelsAnomalyOverTimePlotsMetadata_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided a metadata of average plot for the
          first 1000 series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
        x-versionadded: '2.28'
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyOverTimePlotsMetadataResponse'
          description: Anomaly over Time insights metadata
        '404':
          description: Anomaly over Time insights metadata was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the metadata for the Anomaly over Time insights.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/preview/:
    get:
      description: Retrieve the preview for the Anomaly over Time plots.
      operationId: projectsDatetimeModelsAnomalyOverTimePlotsPreview_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided an average plot for the first 1000
          series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: Retrieve plots for a specific backtest (use the backtest index
          starting from zero) or `holdout`. If not specified the first backtest (backtest
          index 0) will be used.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data for the backtest/holdout.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - training
          - validation
          type: string
      - description: Only bins with predictions exceeding this threshold will be returned
          in the response.
        in: query
        name: predictionThreshold
        required: false
        schema:
          default: 0.5
          exclusiveMinimum: true
          maximum: 1
          minimum: 0
          type: number
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyOverTimePlotsPreviewResponse'
          description: Anomaly over Time plots preview
        '404':
          description: Anomaly over Time plots preview was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the preview for the Anomaly over Time plots.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/backtestStabilityPlot/:
    get:
      description: 'Retrieve a plot displaying the stability of the datetime model
        across different backtests.


        All durations and datetimes should be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.'
      operationId: projectsDatetimeModelsBacktestStabilityPlot_list
      parameters:
      - description: The name of the metric to retrieve the scores for. If omitted,
          the default project metric will be used
        in: query
        name: metricName
        required: false
        schema:
          type: string
      - description: The forecast distance to retrieve the plot for. If not specified,
          the scores for each partition are aggregated across all forecast distances.
          This parameter is only available for time series models.
        in: query
        name: forecastDistance
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BacktestStabilityPlotResponse'
          description: Backtest stability plot data for datetime partitioned model.
        '422':
          description: Backtest stability plot data not available.
      summary: Retrieve a plot displaying the stability of the datetime model across
        different backtests.
      tags:
      - insights
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/backtests/:
    post:
      description: Score all the available backtests of a datetime model.
      operationId: projectsDatetimeModelsBacktests_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Scoring of all the available backtests of a datetime model
            has been successfully requested.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Score all the available backtests of a datetime model.
      tags:
      - models
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/:
    get:
      description: 'Retrieve the Accuracy Over Time (AOT) chart data for an external
        dataset for a project.

        Datetimes are specified in accordance with :ref:`timestamp and duration formatting
        rules <time_format>`.'
      operationId: projectsDatetimeModelsDatasetAccuracyOverTimePlots_retrieve
      parameters:
      - description: The limit of returned bins.
        in: query
        name: maxBinSize
        required: false
        schema:
          default: 500
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: 'The start of the date range to return (UTC string), for example:
          ''2010-05-13T00:00:00.000000Z''. If not specified, the start date for this
          model and source of the data will be used instead.'
        in: query
        name: startDate
        required: false
        schema:
          format: date-time
          type: string
      - description: 'The end of the date range to return (UTC string), for example:
          ''2010-05-13T00:00:00.000000Z''. If not specified, the end date for this
          model and source of the data will be used instead.'
        in: query
        name: endDate
        required: false
        schema:
          format: date-time
          type: string
      - description: Specifies at which resolution the data should be binned. If not
          specified, optimal resolution will be used to build chart data such that
          bins <= `maxBinSize`.
        in: query
        name: resolution
        required: false
        schema:
          enum:
          - microseconds
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
      - description: The project id which was used to compute the AOT chart.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model id which was used to compute the AOT chart.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset id which was used to compute the AOT chart.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AOTChartRetrieveResponse'
          description: Accuracy Over Time (AOT) chart data for an external dataset
            for a project.
        '404':
          description: No insights found.
      summary: Retrieve the Accuracy Over Time (AOT) chart data for an external dataset
        for a project.
      tags:
      - insights
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/metadata/:
    get:
      description: 'Retrieve the metadata of the Accuracy Over Time (AOT) chart for
        an external dataset.

        Datetimes are specified in accordance with :ref:`timestamp and duration formatting
        rules <time_format>`.'
      operationId: projectsDatetimeModelsDatasetAccuracyOverTimePlotsMetadata_list
      parameters:
      - description: The project id which was used to compute the AOT chart.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model id which was used to compute the AOT chart.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset id which was used to compute the AOT chart.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AOTChartMetadataResponse'
          description: Metadata of the Accuracy Over Time (AOT) chart for an external
            dataset.
        '404':
          description: No insights found.
      summary: Retrieve the metadata of the Accuracy Over Time (AOT) chart for an
        external dataset.
      tags:
      - insights
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/preview/:
    get:
      description: 'Retrieve a preview of the Accuracy Over Time (AOT) chart for an
        external dataset.

        Datetimes are specified in accordance with :ref:`timestamp and duration formatting
        rules <time_format>`.'
      operationId: projectsDatetimeModelsDatasetAccuracyOverTimePlotsPreview_list
      parameters:
      - description: The project id which was used to compute the AOT chart.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model id which was used to compute the AOT chart.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset id which was used to compute the AOT chart.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AOTChartPreviewResponse'
          description: Preview of the Accuracy Over Time (AOT) chart for an external
            dataset.
        '404':
          description: No insights found.
      summary: Retrieve a preview of the Accuracy Over Time (AOT) chart for an external
        dataset.
      tags:
      - insights
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/datetimeTrendPlots/:
    post:
      description: "Computes Datetime Trend plots for time series and OTV projects:\n\
        * For OTV projects, computes Accuracy over Time plots.\n* For time series\
        \ supervised projects, computes both Accuracy over Time plots and Forecast\
        \ vs Actual plots.\n.. minversion:: v2.25\n   * For unsupervised time series\
        \ and OTV models, computes Anomaly Over Time plots.\n.. note::\n   For the\
        \ multiseries time series projects only first 1000 series in alphabetical\
        \ order    and an average plot for them will be computed.\n.. note::\n   Maximum\
        \ 100 forecast distances can be requested for calculation in time series supervised\
        \ projects."
      operationId: projectsDatetimeModelsDatetimeTrendPlots_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatetimeTrendPlotsCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeTrendPlotsResponse'
          description: Datetime Trend plots computation job submitted successfully.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: There were invalid parameters in the submitted request. See
            the `message` field for more details.
      summary: Computes Datetime Trend plots for time series and OTV projects.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/:
    get:
      description: 'Retrieve Feature Effects for a model backtest.

        Feature Effects provides partial dependence and predicted vs actual values
        for the top 500 features, ordered by feature impact score.

        The partial dependence shows marginal effect of a feature on the target variable
        after accounting for the average effects of all other predictive features.
        It indicates how, holding all other variables except the feature of interest
        as they were, the value of this feature affects your prediction.

        If a Feature Effects job was previously submitted for a given backtest, this
        endpoint will return a response structured as {"message": <message>, "jobId":
        <jobId>} where `jobId` is the ID of the job. Retrieve the job with :http:get:`/api/v2/projects/(projectId)/jobs/(jobId)/`'
      operationId: projectsDatetimeModelsFeatureEffects_list
      parameters:
      - description: Models data source.
        in: query
        name: source
        required: false
        schema:
          default: training
          enum:
          - training
          - validation
          - holdout
          type: string
      - description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
          `startstop`.'
        in: query
        name: backtestIndex
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureEffectsDatetimeResponse'
          description: ''
        '403':
          description: User does not have permission to view the project.
        '404':
          description: Project, model, source, backtest index, or computation results
            do not exist.
      summary: Retrieve Feature Effects for a model backtest.
      tags:
      - insights
      x-versionadded: v2.18
    post:
      description: 'Add a request to the queue to calculate Feature Effects for a
        backtest.

        If the job has been previously submitted, the request fails, returning the
        `jobId` of the previously submitted job. Use this `jobId` to check status
        of the previously submitted job.'
      operationId: projectsDatetimeModelsFeatureEffects_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureEffectsCreateDatetime'
      responses:
        '202':
          description: The Feature Effects request for a backtest has been successfully
            submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have permission to view or submit jobs for the
            project.
        '404':
          description: Provided project, model, or backtest index does not exist.
        '422':
          description: Queue submission error.
      summary: Add a request to the queue to calculate Feature Effects for a backtest.
      tags:
      - insights
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffectsMetadata/:
    get:
      description: 'Retrieve Feature Effects metadata for each backtest. Response
        contains status and available sources for each backtest of the model.

        One of the provided `backtestIndex` indexes used for submitting the compute
        request and retrieving Feature Effects.

        * Start/stop models contain a single `backtestIndex` response value of `startstop`.

        * Other models contain `backtestIndex` of `0`, `1`, ..., `holdout`.

        One of the provided `source` parameters used for retrieving Feature Effects.

        * Each backtest source can be, at a minimum, `training` or `validation`. If
        holdout is configured for the project, `backtestIndex` also includes `holdout`
        with sources `training` and `holdout`.

        * Source value of `training` is always available. (versions prior to v2.17
        support `validation` only)

        * When a start/stop model is trained into `validation` or `holdout` without
        stacked predictions (i.e., no out-of-sample predictions in `validation` or
        `holdout`), `validation` and `holdout` sources are not available.

        * Source `holdout` is not available when there is no holdout configured for
        the project.'
      operationId: projectsDatetimeModelsFeatureEffectsMetadata_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelXrayMetadataDatetimeResponse'
          description: ''
        '403':
          description: User does not have permission to view the project.
        '404':
          description: Project or model does not exist.
        '422':
          description: The model is not datetime partitioned.
      summary: Retrieve Feature Effects metadata for each backtest. Response contains
        status and available sources for each backtest of the model.
      tags:
      - insights
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastDistanceStabilityPlot/:
    get:
      description: "Retrieve a plot displaying the stability of the time series model\
        \ across different forecast distances.\n.. note::\n   All durations and datetimes\
        \ are specified in accordance with the   :ref:`timestamp and duration formatting\
        \ rules <time_format>`.\n"
      operationId: projectsDatetimeModelsForecastDistanceStabilityPlot_list
      parameters:
      - description: The name of the metric to retrieve the scores for. If omitted,
          the default project metric will be used.
        in: query
        name: metricName
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastDistanceStabilityPlotResponse'
          description: Forecast distance stability plot for datetime partitioned model.
        '422':
          description: There was an error while retrieving the plot.
      summary: Retrieve a plot displaying the stability of the time series model across
        different forecast distances.
      tags:
      - insights
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/:
    get:
      description: Retrieve the data for the Forecast vs Actual plots.
      operationId: projectsDatetimeModelsForecastVsActualPlots_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided an average plot for the first 1000
          series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: Retrieve plots for a specific backtest (use the backtest index
          starting from zero) or `holdout`. If not specified the first backtest (backtest
          index 0) will be used.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data for the backtest/holdout.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - training
          - validation
          type: string
      - description: Specifying at which resolution the data should be binned. If
          not specified, optimal resolution will be used to build chart data with
          number of bins <= `maxBinSize`
        in: query
        name: resolution
        required: false
        schema:
          enum:
          - milliseconds
          - seconds
          - minutes
          - hours
          - days
          - weeks
          - months
          - quarters
          - years
          type: string
      - description: The start of forecast distance range (forecast window) to retrieve.
          If not specified, the first forecast distance for this project will be used.
          Forecast distance specifies the number of time steps between the predicted
          point and the origin point. Only available for time series supervised projects.
        in: query
        name: forecastDistanceStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The end of forecast distance range (forecast window) to retrieve.
          If not specified, the last forecast distance for this project will be used.
          Forecast distance specifies the number of time steps between the predicted
          point and the origin point. Only available for time series supervised projects.
        in: query
        name: forecastDistanceEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: Specifies the maximum number of bins for the retrieval.
        in: query
        name: maxBinSize
        required: false
        schema:
          default: 500
          maximum: 1000
          minimum: 1
          type: integer
      - description: The start of the date range to return. If not specified, start
          date for requested plots will be used.
        in: query
        name: startDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The end of the date range to return. If not specified, end date
          for requested plots will be used.
        in: query
        name: endDate
        required: false
        schema:
          format: date-time
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastVsActualPlotsDataResponse'
          description: Forecast vs Actual plots data
        '404':
          description: Forecast vs Actual plots data was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the data for the Forecast vs Actual plots.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/metadata/:
    get:
      description: Retrieve the metadata for the Forecast vs Actual insights.
      operationId: projectsDatetimeModelsForecastVsActualPlotsMetadata_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided a metadata of average plot for the
          first 1000 series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
        x-versionadded: '2.28'
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastVsActualPlotsMetadataResponse'
          description: Forecast vs Actual insights metadata
        '404':
          description: Forecast vs Actual insights metadata was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the metadata for the Forecast vs Actual insights.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/preview/:
    get:
      description: Retrieve the preview for the Forecast vs Actual plots.
      operationId: projectsDatetimeModelsForecastVsActualPlotsPreview_list
      parameters:
      - description: The name of the series to retrieve. Only available for time series
          multiseries projects. If not provided an average plot for the first 1000
          series will be retrieved.
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: Retrieve plots for a specific backtest (use the backtest index
          starting from zero) or `holdout`. If not specified the first backtest (backtest
          index 0) will be used.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
      - description: The source of the data for the backtest/holdout.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - training
          - validation
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeTrendPlotsPreviewResponse'
          description: Forecast vs Actual plots preview
        '404':
          description: Forecast vs Actual plots preview was not found
        '422':
          description: Invalid parameters were submitted
      summary: Retrieve the preview for the Forecast vs Actual plots.
      tags:
      - insights
      x-versionadded: v2.24
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/:
    get:
      description: Retrieve feature effects for each class in a multiclass datetime
        model.
      operationId: projectsDatetimeModelsMulticlassFeatureEffects_list
      parameters:
      - description: Models data source.
        in: query
        name: source
        required: false
        schema:
          default: training
          enum:
          - training
          - validation
          - holdout
          type: string
      - description: 'The backtest index. For example: `0`, `1`, ..., `20`, `holdout`,
          `startstop`.'
        in: query
        name: backtestIndex
        required: true
        schema:
          type: string
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Target class label.
        in: query
        name: class
        required: false
        schema:
          nullable: true
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticlassDatetimeFeatureEffectsResponse'
          description: ''
        '403':
          description: User does not have permission to view the project.
        '404':
          description: Project, model, source or computation results do not exist.
      summary: Retrieve feature effects for each class in a multiclass datetime model.
      tags:
      - insights
      x-versionadded: v2.27
    post:
      description: 'Compute feature effects for a multiclass datetime model. If the
        job has been previously submitted, the request fails, returning the ``jobId``
        of the previously submitted job. Use this ``jobId`` to check status of the
        previously submitted job.

        NOTE: feature effects are computed for top 100 classes.'
      operationId: projectsDatetimeModelsMulticlassFeatureEffects_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MulticlassFeatureEffectDatetimeCreate'
      responses:
        '202':
          description: The Feature Effects request has been successfully submitted.
            See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have permission to view or submit jobs for the
            project.
        '404':
          description: Project, model, source or computation results do not exist.
        '422':
          description: Queue submission error. If the ``rowCount`` exceeds the maximum
            or minimum value for this dataset. Minimum is 10 rows. Maximum is 100000
            rows or the training sample size of the model, whichever is less. If invalid
            class names are provided in ``classes``.If neither ``features`` nor ``topNFeatures``
            is provided. If invalid ``backtestIndex`` is provided.
      summary: Compute feature effects for a multiclass datetime model.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesHistograms/:
    get:
      description: 'Retrieve the histograms for series insights.


        Histogram is computed only for first 1000 series (ordered by name).'
      operationId: projectsDatetimeModelsMultiseriesHistograms_list
      parameters:
      - description: The series attribute to build a histogram for.
        in: query
        name: attribute
        required: true
        schema:
          default: rowCount
          enum:
          - rowCount
          - duration
          - startDate
          - endDate
          - targetAverage
          - validationScore
          - backtestingScore
          - holdoutScore
          - rowPercent
          - clusterCount
          - clustering
          type: string
      - description: The name of the metric to retrieve the histogram for attributes
          "validationScore", "backtestingScore", and"holdoutScore". If omitted, the
          default project metric will be used.
        in: query
        name: metric
        required: false
        schema:
          type: string
      - description: The number of bins in a histogram. Can be 10, 20 or 50. The default
          is 10.
        in: query
        name: bins
        required: true
        schema:
          default: '10'
          enum:
          - '10'
          - '20'
          - '50'
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiseriesHistogramsRetrieveResponse'
          description: Retrieve the histograms for series insights in form of an array
            of histogram bins.
        '403':
          description: User does not have permissions to manage models.
        '404':
          description: Model with specified `modelId` doesn't exist, or user does
            not have access to the project.
        '422':
          description: Metric provided to query is not found.
      summary: Retrieve the histograms for series insights.
      tags:
      - insights
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/:
    get:
      description: List the scores per individual series for the specified multiseries
        model.
      operationId: projectsDatetimeModelsMultiseriesScores_list
      parameters:
      - description: Only the series containing the given value in one of the series
          ID columns will be returned if specified.
        in: query
        name: multiseriesValue
        required: false
        schema:
          type: string
      - description: The number of results to skip. Defaults to 0 if not specified.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of results to return. Defaults to 100 if not
          specified.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          minimum: 0
          type: integer
      - description: The name of the metric to retrieve the scores for.If omitted,
          the default project metric will be used.
        in: query
        name: metric
        required: false
        schema:
          type: string
      - description: 'Used for sorting the series. Supported attributes for ordering
          include: "multiseriesValue", "rowCount", "validationScore", "holdoutScore"  and
          "backtestingScore", "startDate", "endDate", and "targetAverage".Prefix the
          attribute name with a dash to sort in descending order,e.g. `orderBy=-rowCount`.
          If multiple series with equal values of the ordering attributeexist, ties
          will be broken arbitrarily.'
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - multiseriesValue
          - -multiseriesValue
          - rowCount
          - -rowCount
          - startDate
          - -startDate
          - endDate
          - -endDate
          - targetAverage
          - -targetAverage
          - validationScore
          - -validationScore
          - backtestingScore
          - -backtestingScore
          - holdoutScore
          - -holdoutScore
          - cluster
          - -cluster
          type: string
      - description: 'Used to specify on which attribute values to filter the series.Supported
          attributes for filtering include: "rowCount", "startDate", "endDate", "targetAverage",
          "validationScore", "holdoutScore", and "backtestingScore".`filterByBins`
          and `numberOfBins` are required if this parameter is used.'
        in: query
        name: filterBy
        required: false
        schema:
          enum:
          - rowCount
          - startDate
          - endDate
          - targetAverage
          - validationScore
          - backtestingScore
          - holdoutScore
          - cluster
          type: string
      - description: Used to specify the number of bins in the histogram on which
          to filter the series.Can be 10, 20 or 50.`filterBy` and `filterByBins` are
          required if this parameter is used.
        in: query
        name: numberOfBins
        required: false
        schema:
          enum:
          - '10'
          - '20'
          - '50'
          type: string
      - description: Used to specify the multiseries histogram bins on which to filter
          the series.`filterBy` and `numberOfBins` are required if this parameter
          is used.
        in: query
        name: filterByBins
        required: false
        schema:
          type: string
      - description: Used to specify the specific cluster on which to filter the series.`filterBy`
          is required if this parameter is used.Only valid for unsupervised clustering
          projects.
        in: query
        name: clusterNames
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeriesAccuracyRetrieveResponse'
          description: Retrieve the accuracy scores for each series for the specified
            multiseries model.
        '403':
          description: User does not have permissions to manage models.
        '404':
          description: Model with specified `modelId` doesn't exist, or user does
            not have access to the project.
        '422':
          description: Metric provided to query is not found.
      summary: List the scores per individual series for the specified multiseries
        model.
      tags:
      - insights
      x-versionadded: v2.16
    post:
      description: "Request the computation of per-series scores for a multiseries\
        \ model.\n.. note::\n   Computation uses available partitions only. This endpoint\
        \ will not compute backtesting   scores if no backtesting scores exist prior\
        \ to this request.\n"
      operationId: projectsDatetimeModelsMultiseriesScores_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SeriesAccuracyCompute'
      responses:
        '202':
          description: Multiseries score computation has been successfully requested.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Request the computation of per-series scores for a multiseries model.
      tags:
      - insights
      x-versionadded: v2.16
  /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/file/:
    get:
      description: Retrieve the CSV file for the series accuracy.
      operationId: projectsDatetimeModelsMultiseriesScoresFile_list
      parameters:
      - description: If specified, only the series containing the given value in one
          of the series ID columns will be returned.
        in: query
        name: multiseriesValue
        required: false
        schema:
          type: string
      - description: The name of the metric to retrieve the scores for. If omitted,
          the default project metric will be used.
        in: query
        name: metric
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a file containing the series accuracy
            data in csv format.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=Series
                accuracy (model:<lid>) (<metric>).csv").
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - text/csv
                type: string
        '403':
          description: User does not have permissions to manage models.
        '404':
          description: Model with specified `modelId` doesn't exist, or user does
            not have access to the project.
        '422':
          description: Metric provided to query is not found.
      summary: Retrieve the CSV file for the series accuracy.
      tags:
      - insights
      x-versionadded: v2.16
  /api/v2/projects/{projectId}/datetimePartitioning/:
    get:
      description: 'Retrieve datetime partitioning configuration


        The datetime partition object in the response describes the full partitioning
        parameters. Since it becomes available after the target has been fully specified
        and the project is ready for modeling, there are some additional fields available
        compared to the response from :http:post:`/api/v2/projects/(projectId)/datetimePartitioning/`.


        The available training data corresponds to all the data available for training,
        while the primary training data corresponds to the data that can be used to
        train while ensuring that all backtests are available. If a model is trained
        with more data than is available in the primary training data, then all backtests
        may not have scores available.


        All durations and datetimes will be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.'
      operationId: projectsDatetimePartitioning_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinalDatetimePartitioningResponse'
          description: Generated datetime partitioning.
        '422':
          description: Partitioning has not been set.
      summary: Retrieve datetime partitioning configuration.
      tags:
      - datetime_partitioning
      x-versionadded: v2.6
    post:
      description: 'Preview the fully specified datetime partitioning generated by
        the requested configuration.

        DEPRECATED: Please use the optimized partitioning route instead: :http:post:`/api/v2/projects/(projectId)/optimizedDatetimePartitionings/`


        Populates the full datetime partitioning that would be used if the same arguments
        were passed to :http:patch:`/api/v2/projects/(projectId)/aim/` based on the
        requested configuration, generating defaults for all non-specified values,
        so that potential configurations can be tested prior to setting the target
        and applying a configuration.


        `useTimeSeries` controls whether a time series project should be created or
        a normal project that uses datetime partitioning. See :ref:`Time-Series Projects<time_series_overview>`
        for more detail on the differences between time series projects and datetime
        partitioned projects. Time-series projects are only available to some users
        and use the additional settings of `featureDerivationWindowStart` and `featureDerivationWindowEnd`
        to establish feature derivation window and `forecastWindowStart` and `forecastWindowEnd`
        to establish a forecast window. The overview referenced above provides more
        information about using feature derivation and forecast windows.


        When specifying a feature derivation window of a forecast window, the number
        of units it spans (end - start) must be an integer multiple of the timeStep
        of the datetimePartitionColumn.


        All durations and datetimes should be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.'
      operationId: projectsDatetimePartitioning_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatetimePartitioningDataForOpenApi'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimePartitioningResponse'
          description: Generated datetime partitioning.
        '404':
          description: Requested feature was not found.
        '422':
          description: Partitioning generation failed.
      summary: Preview the fully specified datetime partitioning generated by the
        requested configuration. DEPRECATED API.
      tags:
      - datetime_partitioning
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/deploymentReadyModels/:
    post:
      description: Prepare a specific model for deployment. This model will go through
        the recommendation stages.
      operationId: projectsDeploymentReadyModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrepareForDeployment'
      responses:
        '201':
          description: Start preparing the model for deployment.
        '422':
          description: An error occurred when submitting the model job
      summary: Prepare a model for deployment
      tags:
      - models
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/discardedFeatures/:
    get:
      description: Get features which were discarded during feature reduction process.
      operationId: projectsDiscardedFeatures_list
      parameters:
      - description: Case insensitive search against discarded feature names.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscardedFeaturesResponse'
          description: Discarded features.
        '422':
          description: Unable to process the request
      summary: Get discarded features.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/documentPages/{documentPageId}/file/:
    get:
      description: Returns a file for a single document page.
      operationId: projectsDocumentPagesFile_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Id of the document page
        in: path
        name: documentPageId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response is an image file (not JSON) that can be saved
            or displayed.
        '404':
          description: Document page not found
      summary: Returns a file for a single document page.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/documentTextExtractionSamples/:
    get:
      description: Lists metadata on all computed document text extraction samples
        in the project across all models.
      operationId: projectsDocumentTextExtractionSamples_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTextExtractionSamplesListMetadataResponse'
          description: Metadata on computed document text extraction samples in the
            project.
      summary: Lists metadata on all computed document text extraction samples in
        the project across all models.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/documentThumbnailBins/:
    get:
      description: Lists document thumbnail bins for every target value or range including
        the metadata for one example thumbnail of the bin.
      operationId: projectsDocumentThumbnailBins_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Name of the document feature
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentThumbnailBinsListResponse'
          description: Returns a list of document thumbnail bins for every target
            value or range including the metadata for one example thumbnail of the
            bin.
        '422':
          description: The request cannot be processed
      summary: Lists document thumbnail bins for every target value or range including
        the metadata for one example thumbnail of the bin.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/documentThumbnailSamples/:
    get:
      description: List all metadata for document thumbnails in the EDA sample.
      operationId: projectsDocumentThumbnailSamples_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Name of the document feature
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentThumbnailMetadataListResponse'
          description: A paginated list of document thumbnail metadata.
        '422':
          description: The request cannot be processed
      summary: List all metadata for document thumbnails in the EDA sample.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/documentThumbnails/:
    get:
      description: Returns a list of document thumbnail metadata elements.
      operationId: projectsDocumentThumbnails_list
      parameters:
      - description: Name of the document feature
        in: query
        name: featureName
        required: false
        schema:
          type: string
      - description: For classification projects, when specified, returns only document
          pages corresponding to this target value. Mutually exclusive with targetBinStart/targetBinEnd.
        in: query
        name: targetValue
        required: false
        schema:
          anyOf:
          - type: number
          - type: string
      - description: For regression projects, when specified, returns only document
          pages corresponding to the target values above this value. Mutually exclusive
          with targetValue. Must be specified with targetBinEnd.
        in: query
        name: targetBinStart
        required: false
        schema:
          anyOf:
          - type: number
          - type: string
      - description: For regression projects, when specified, only document thumbnails
          corresponding to the target values below this will be returned. Mutually
          exclusive with targetValue. Must be specified with targetBinStart.
        in: query
        name: targetBinEnd
        required: false
        schema:
          anyOf:
          - type: number
          - type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 100
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentThumbnailMetadataListResponse'
          description: Returns a list of document thumbnail metadata elements.
        '422':
          description: 'The request cannot be processed. Possible reasons include:
            - Cannot supply value for both TargetValue and TargetBin. - Must supply
            both TargetBinStart and TargetBinEnd. - TargetBin parameters are only
            valid for regression projects. - TargetValue parameter is only valid for
            classification projects.'
      summary: Returns a list of document thumbnail metadata elements.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/documentsDataQualityLog/:
    get:
      description: Retrieve the documents data quality log content and log length
        as JSON.
      operationId: projectsDocumentsDataQualityLog_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentsDataQualityLogLinesResponse'
          description: A paginated list of lines of the document data quality log.
        '422':
          description: Not a data quality enabled project
      summary: Retrieve the documents data quality log content and log length as JSON.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/documentsDataQualityLog/file/:
    get:
      description: Retrieve a text file containing the documents data quality log.
      operationId: projectsDocumentsDataQualityLogFile_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the documents data quality log.
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data.
              schema:
                enum:
                - text/plain
                type: string
        '422':
          description: Not a data quality enabled project
      summary: Retrieve a text file containing the documents data quality log.
      tags:
      - documents
      x-versionadded: v2.32
  /api/v2/projects/{projectId}/duplicateImages/{column}/:
    get:
      description: Get a list of duplicate images containing the number of occurrences
        of each image
      operationId: projectsDuplicateImages_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Column parameter to filter the list of duplicate images returned
        in: path
        name: column
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateImageTableResponse'
          description: List of image metadata
      summary: Get a list of duplicate images containing the number of occurrences
        of each image
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/eureqaDistributionPlot/{solutionId}/:
    get:
      description: 'Retrieve Eureqa model details plot.


        Available for classification projects only'
      operationId: projectsEureqaDistributionPlot_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the solution to return data for.
        in: path
        name: solutionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EureqaDistributionDetailResponse'
          description: Eureqa model details plot.
        '404':
          description: Data was not found.
      summary: Retrieve Eureqa model details plot.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/eureqaModelDetail/{solutionId}/:
    get:
      description: 'Retrieve Eureqa model details plot.


        Available for regression projects only'
      operationId: projectsEureqaModelDetail_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the solution to return data for.
        in: path
        name: solutionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EureqaModelDetailResponse'
          description: Eureqa model details plot.
        '404':
          description: Data was not found.
      summary: Retrieve Eureqa model details plot.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/eureqaModels/:
    post:
      description: Create a new model from an existing eureqa solution.
      operationId: projectsEureqaModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EureqaLeaderboardEntryPayload'
      responses:
        '200':
          description: Request accepted, creation is underway.
          headers:
            Location:
              description: The location at which the new model can be retrieved.
              schema:
                type: string
        '404':
          description: Data not found.
        '422':
          description: Model for this solution already exists.
      summary: Create a new model from an existing eureqa solution.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/eureqaModels/{modelId}/:
    get:
      description: 'Retrieve the pareto front for the specified Eureqa model.


        Only the best solution in the pareto front will have a corresponding model
        initially. Models can be created for other solutions using :http:post:`/api/v2/projects/(projectId)/eureqaModels/`.'
      operationId: projectsEureqaModels_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParetoFrontResponse'
          description: Pareto front for the Eureqa model.
        '404':
          description: Data was not found.
      summary: Retrieve the pareto front for the specified Eureqa model.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/externalScores/:
    get:
      description: List of scores on prediction datasets for a project with filtering
        option by dataset or model or both of them. Prediction dataset may have scores
        if it contained a column with actual values and predictions were computed
        on this dataset.
      operationId: projectsExternalScores_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: If provided will return scores for dataset with matching datasetId.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: If provided will return scores for model with matching modelId.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalScoresListResponse'
          description: List of scores on prediction datasets.
        '404':
          description: Project not found.
      summary: List of scores on prediction datasets for a project.
      tags:
      - insights
      x-versionadded: v2.21
    post:
      description: Compute model scores for external dataset, first upload your dataset
        to the project, and then using the corresponding datasetId, compute scores
        against that dataset. Computing external scores and insights depends on computed
        prediction, predictions will be computed if they are not available for this
        dataset. In order to compute scores and insights, uploaded dataset should
        contain actual value column. This api is not available in time series projects.
      operationId: projectsExternalScores_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalScoresCreate'
      responses:
        '202':
          description: ''
        '422':
          description: The project type does not support or modeling is not finished
            yet.
      summary: Compute model scores for external dataset.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/externalTimeSeriesBaselineDataValidationJobs/:
    post:
      description: This route validates if a provided catalog version id can be used
        as baseline for calculating metrics. This functionality is available only
        for time series projects.For a baseline dataset to be valid, the number of
        unique date amd multiseries_id columnrows must match the unique number of
        date and multiseries_id column rows in the uploadedtraining dataset. This
        functionality is limited to one forecast distance. Additionally, the catalog
        must be a snapshot.
      operationId: projectsExternalTimeSeriesBaselineDataValidationJobs_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalTSBaselinePayload'
      responses:
        '202':
          description: Validate baseline data that is provided in the form of a catalog
            version id. We willconfirm that the dataset contains the proper date,
            target column, and multiseries ID column. If the provided dataset meets
            the criteria, the job will be successful.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have access to this functionality.
        '422':
          description: Unable to process external time sereis baseline validation
            job.
      summary: Validate baseline data
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/projects/{projectId}/externalTimeSeriesBaselineDataValidationJobs/{baselineValidationJobId}/:
    get:
      description: Retrieve information to confirm if the validation job triggered
        via /api/v2/projects/(projectId)/externalTimeSeriesBaselineDataValidationJobs/
        is valid.
      operationId: projectsExternalTimeSeriesBaselineDataValidationJobs_retrieve
      parameters:
      - description: The project to retrieve the validation job information from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The id for the validation job
        in: path
        name: baselineValidationJobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalTSBaselineResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
        '404':
          description: External time series validation job not found.
      summary: Retrieve Baseline Validation Job
      tags:
      - projects
      x-versionadded: v2.26
  /api/v2/projects/{projectId}/featureAssociationFeaturelists/:
    get:
      description: List all featurelists with feature association matrix availability
        flags for a project.
      operationId: projectsFeatureAssociationFeaturelists_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureAssociationListControllerResponse'
          description: List available Feature Association Matrix for a project.
        '404':
          description: Project not found.
      summary: List all featurelists with feature association matrix availability
        flags for a project.
      tags:
      - insights
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/featureAssociationMatrix/:
    get:
      description: " Retrieval for pairwise feature association statistics.\n    \
        \    Projects created prior to v2.17 are not supported by this feature."
      operationId: projectsFeatureAssociationMatrix_list
      parameters:
      - description: the type of dependence for the data. Must be either `association`
          or `correlation`. Since v2.19 this is optional and defaults to `association`.
        in: query
        name: type
        required: true
        schema:
          default: association
          enum:
          - association
          - correlation
          type: string
      - description: the name of a metric to get pairwise data for. Must be one of
          `mutualInfo`, `cramersV`, `spearman`, `pearson`, or `tau`. Since v2.19 this
          is optional and defaults to `mutualInfo`.
        in: query
        name: metric
        required: true
        schema:
          default: mutualInfo
          enum:
          - mutualInfo
          - cramersV
          - spearman
          - pearson
          - tau
          type: string
      - description: the feature list to lookup FAM data for. By default, depending
          on the type of the project `Informative Features` or `Timeseries Informative
          Features` list will be used.
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureAssociationRetrieveControllerResponse'
          description: Retrieve Feature Association Matrix for project.
        '404':
          description: Wrong query parameters specified or no such `projectId` exists.
        '422':
          description: The project does not support feature associations.
      summary: Retrieval for pairwise feature association statistics.
      tags:
      - insights
      x-versionadded: v2.17
    post:
      description: Compute feature association matrix for given featurelist.
      operationId: projectsFeatureAssociationMatrix_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureAssociationCreatePayload'
      responses:
        '202':
          description: ''
        '404':
          description: A project with `projectId` or a featurelist with `featurelistId`
            was not found.
        '422':
          description: The feature association matrix calculation is not supported
            for this project.
      summary: Compute feature association matrix.
      tags:
      - insights
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/featureAssociationMatrixDetails/:
    get:
      description: "Retrieval for feature association plotting between a pair of features.\n\
        \        Projects created prior to v2.17 are not supported by this feature."
      operationId: projectsFeatureAssociationMatrixDetails_list
      parameters:
      - description: The name of a feature.
        in: query
        name: feature1
        required: true
        schema:
          type: string
      - description: the name of another feature.
        in: query
        name: feature2
        required: true
        schema:
          type: string
      - description: the feature list to lookup FAM data for. By default, depending
          on the type of the project `Informative Features` or `Timeseries Informative
          Features` list will be used.
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureAssociationDetailsRetrieveControllerResponse'
          description: Retrieval for feature association plotting between a pair of
            features.
        '404':
          description: Wrong query parameters specified or no such `projectId` exists.
        '422':
          description: This project does not support feature associations, (e.g. multilabel,
            multiseries, time series unsupervised projects.).
      summary: Retrieval for feature association plotting between a pair of features.
      tags:
      - insights
      x-versionadded: v2.17
  /api/v2/projects/{projectId}/featureDiscoveryDatasetDownload/:
    get:
      description: Download the project dataset with features added by feature discovery
      operationId: projectsFeatureDiscoveryDatasetDownload_list
      parameters:
      - description: The ID of the dataset to use for the prediction.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project dataset file.
        '404':
          description: Data is not found.
        '422':
          description: Unable to process the request.
      summary: Download the project dataset with features added by feature discovery
      tags:
      - projects
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/featureDiscoveryLogs/:
    get:
      description: Retrieve the feature discovery log content and log length for a
        feature discovery project. This route is only supported for feature discovery
        projects that have finished partitioning
      operationId: projectsFeatureDiscoveryLogs_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureDiscoveryLogListResponse'
          description: Feature discovery log data.
        '422':
          description: Unable to process the request.
      summary: Retrieve the feature discovery log content and log length
      tags:
      - projects
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/featureDiscoveryLogs/download/:
    get:
      description: Retrieve a text file containing the feature discovery log. This
        route is only supported for feature discovery projects that have finished
        partitioning.
      operationId: projectsFeatureDiscoveryLogsDownload_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Feature discovery log file.
        '422':
          description: Unable to process the request.
      summary: Retrieve a text file containing the feature discovery log
      tags:
      - projects
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/featureDiscoveryRecipeSQLs/download/:
    get:
      description: Download feature discovery SQL recipe for a project
      operationId: projectsFeatureDiscoveryRecipeSQLsDownload_list
      parameters:
      - description: Model ID to export recipe for
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: Return status only for availability check
        in: query
        name: statusOnly
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project feature discovery SQL recipe file.
        '400':
          description: Unable to process the request
        '404':
          description: Data not found
      summary: Download feature discovery SQL recipe
      tags:
      - projects
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/featureDiscoveryRecipeSqlExports/:
    post:
      description: Generate feature discovery SQL recipe for a project
      operationId: projectsFeatureDiscoveryRecipeSqlExports_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureDiscoveryRecipeSQLsExport'
      responses:
        '202':
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '404':
          description: Data not found
        '422':
          description: Unable to process the request
      summary: Generate feature discovery SQL recipe
      tags:
      - projects
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/featureHistograms/{featureName}/:
    get:
      description: Get histogram chart data for a specific feature. Information that
        can be used to build histogram charts. Plot data returned is based on raw
        data that is calculated during initial project creation and updated after
        the project's target variable has been selected. The number of bins in the
        histogram is no greater than the requested limit.
      operationId: projectsFeatureHistograms_retrieve
      parameters:
      - description: maximum number of bins in the returned plot
        in: query
        name: binLimit
        required: true
        schema:
          default: 60
          maximum: 60
          minimum: 1
          type: integer
      - description: name of the top 50 key for which plot to be retrieved. (Only
          required for the Summarized categorical feature)
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: The ID of the project
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: 'the name of the feature Note: DataRobot renames some features,
          so the feature name may not be the one from your original data. You can
          use :http:get:`/api/v2/projects/(projectId)/features/` to list the features
          and check the name. Note to users with non-ascii features names: The feature
          name should be utf-8-encoded (before URL-quoting) '
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureHistogramResponse'
          description: The feature histogram chart data
        '404':
          description: A Histogram is unavailable for this feature because the data
            contains unsupportedfeature types (e.g., image, location).
      summary: Get feature histogram
      tags:
      - projects
      x-versionadded: v2.14
  /api/v2/projects/{projectId}/featureLineages/{featureLineageId}/:
    get:
      description: Retrieve single Feature Discovery feature lineage.
      operationId: projectsFeatureLineages_retrieve
      parameters:
      - description: The project to retrieve a lineage from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: id of a feature lineage object to return. You can access the
          id with  *ModelingFeatureRetrieveController*.
        in: path
        name: featureLineageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureLineageResponse'
          description: ''
      summary: Retrieve Feature Discovery Lineage
      tags:
      - projects
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/featurelists/:
    get:
      description: List all featurelists for a project.
      operationId: projectsFeaturelists_list
      parameters:
      - description: Property to sort featurelists by in the response
        in: query
        name: sortBy
        required: false
        schema:
          enum:
          - name
          - description
          - features
          - numModels
          - created
          - isUserCreated
          - -name
          - -description
          - -features
          - -numModels
          - -created
          - -isUserCreated
          type: string
      - description: Limit results by specific featurelists. Performs a substring
          search for the term you provide in featurelist names.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FeaturelistResponse'
                type: array
          description: The list of featurelists
      summary: List featurelists
      tags:
      - projects
      x-versionadded: v2.0
    post:
      description: Create a new featurelist from list of feature names.
      operationId: projectsFeaturelists_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFeaturelist'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistResponse'
          description: The newly created featurelist in the same format as :http:get:`/api/v2/projects/(projectId)/featurelists/(featurelistId)/`.
      summary: Create a new featurelist.
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/featurelists/{featurelistId}/:
    delete:
      description: 'Delete a specified featurelist.

        All models using a featurelist, whether as the training featurelist or as
        a monotonic constraint featurelist, will also be deleted when the deletion
        is executed and any queued or running jobs using it will be cancelled. Similarly,
        predictions made on these models will also be deleted. All the entities that
        are to be deleted with a featurelist are described as "dependencies" of it.
        When deleting a featurelist with dependencies, users must pass an additional
        query parameter `deleteDependencies` to confirm they want to delete the featurelist
        and all its dependencies. Without that option, only featurelists with no dependencies
        may be successfully deleted.

        Featurelists configured into the project as a default featurelist or as a
        default monotonic constraint featurelist cannot be deleted.

        Featurelists used in a model deployment cannot be deleted until the model
        deployment is deleted.'
      operationId: projectsFeaturelists_delete
      parameters:
      - description: Preview the deletion results without actually deleting the featurelist.
        in: query
        name: dryRun
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Automatically delete all dependencies of a featurelist. If false
          (default), will only delete the featurelist if it has no dependencies. The
          value of deleteDependencies will not be used if dryRun is true.If a featurelist
          has dependencies, deleteDependencies must be true for the request to succeed.
        in: query
        name: deleteDependencies
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The featurelist ID.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistDestroyResponse'
          description: ''
      summary: Delete a specified featurelist.
      tags:
      - projects
      x-versionadded: v2.13
    get:
      description: Retrieve a single known feature list.
      operationId: projectsFeaturelists_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The featurelist ID.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistResponse'
          description: Retrieve a single known feature list.
      summary: Retrieve a feature list
      tags:
      - projects
      x-versionadded: v2.0
    patch:
      description: Update an existing featurelist by ID.
      operationId: projectsFeaturelists_patch
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The featurelist ID.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFeaturelist'
      responses:
        '204':
          description: The featurelist was successfully updated.
        '422':
          description: Update failed due to an invalid payload. This may be because
            the name is identical to an existing featurelist name.
      summary: Update an existing featurelist
      tags:
      - projects
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/features/:
    get:
      description: List the features from a project with descriptive information.
      operationId: projectsFeatures_list
      parameters:
      - description: Property to sort features by in the response
        in: query
        name: sortBy
        required: false
        schema:
          enum:
          - name
          - id
          - importance
          - featureType
          - uniqueCount
          - naCount
          - mean
          - stdDev
          - median
          - min
          - max
          - -name
          - -id
          - -importance
          - -featureType
          - -uniqueCount
          - -naCount
          - -mean
          - -stdDev
          - -median
          - -min
          - -max
          type: string
      - description: Limit results by specific features. Performs a substring search
          for the term you provide in featurelist names.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: Filter features by a specific featurelist ID.
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
      - description: When True, features returned will be filtered to those usable
          for segmented analysis.
        in: query
        name: forSegmentedAnalysis
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProjectFeatureResponse'
                type: array
          description: The list of features
      summary: List project features
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/features/metrics/:
    get:
      description: List the appropriate metrics if a feature were chosen as the target.
        The metrics listed will include both weighted and unweighted metrics - which
        are appropriate will depend on whether a weights column is used.
      operationId: projectsFeaturesMetrics_list
      parameters:
      - description: The name of the feature to check
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureMetricsResponse'
          description: The feature's metrics
      summary: List feature metrics
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/features/{featureName}/:
    get:
      description: Retrieve the specified feature with descriptive information. Descriptive
        information for features also includes summary statistics as of v2.8. These
        are returned via the fields max, min, mean, median, and stdDev. These fields
        are formatted according to the original feature type of the feature. For example,
        the format will be numeric if your feature is numeric, in feet and inches
        if your feature is length type, in currency if your feature is currency type,
        in time format if your feature is time type, or in ISO date format if your
        feature is a date type. Numbers will be rounded so that they have at most
        two non-zero decimal digits. For projects created prior to v2.8, these descriptive
        statistics will not be available. Also, some features, like categorical and
        text features, may not have summary statistics.
      operationId: projectsFeatures_retrieve
      parameters:
      - description: The ID of the project
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: 'the name of the feature Note: DataRobot renames some features,
          so the feature name may not be the one from your original data. You can
          use :http:get:`/api/v2/projects/(projectId)/features/` to list the features
          and check the name. Note to users with non-ascii features names: The feature
          name should be utf-8-encoded (before URL-quoting) '
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The feature information
      summary: Get project feature
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/features/{featureName}/frequentValues/:
    get:
      description: "Retrieve the frequent values information for a particular feature.\n\
        \        Only valid for numeric features.\n        This route returns information\
        \ about the frequent values seen for a particular feature,\n        based\
        \ on the EDA sample of the dataset. Up to 60 values will be returned,\n  \
        \      and when more values are present, they will be bucketed into a level\
        \ called \"==All Other==\"\n        at the end of the response."
      operationId: projectsFeaturesFrequentValues_list
      parameters:
      - description: project id
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: name of the feature
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrequentValuesResponse'
          description: Retrieve the frequent values information for a particular feature.
        '404':
          description: If the feature doesn't exist, or no such projectId exists
        '422':
          description: If the feature isn't numeric
      summary: Retrieve the frequent values information for a particular feature.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/features/{featureName}/multiseriesProperties/:
    get:
      description: 'Time series projects require that each timestamp have at most
        one row corresponding to it. However, multiple series of data can be handled
        within a single project by designating a multiseries ID column that assigns
        each row to a particular series. See the :ref:`multiseries <multiseries>`
        docs on time series projects for more information.


        Note that detection will have to be triggered via :http:post:`/api/v2/projects/(projectId)/multiseriesProperties/`
        in order for multiseries id columns to appear here. The route will return
        successfully with an empty array of detected columns if detection hasn''t
        run yet, or hasn''t found any valid columns.'
      operationId: projectsFeaturesMultiseriesProperties_list
      parameters:
      - description: The project ID to retrieve multiseries properties from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The feature to be used to the datetime partition column.
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiseriesRetrieveResponse'
          description: Request to retrieve the potential multiseries ID columns was
            successful.
      summary: Retrieve potential multiseries ID columns to use with a particular
        datetime partition column.
      tags:
      - projects
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/frozenDatetimeModels/:
    post:
      description: 'Train a frozen datetime model. If no training data is specified,
        the frozen datetime model will be trained on the most recent data using an
        amount of data that is equivalent to the original model. However, if the equivalent
        duration does not provide enough rows for training, then the duration will
        be extended until the minimum is met. Note that this will require the holdout
        of the project to be unlocked.


        All durations and datetimes should be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.


        Note that only one of `trainingDuration`, `trainingRowCount`, `trainingStartDate`
        and `trainingEndDate`, or `useProjectSettings` may be specified.'
      operationId: projectsFrozenDatetimeModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainDatetimeFrozenModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimeModelSubmissionResponse'
          description: The model has been successfully submitted.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have permissions to manage models.
        '404':
          description: Model with specified `modelId` does not exist, or user does
            not have access to the project.
        '422':
          description: Model with specified `modelId` is deprecated, or it does not
            support retraining with specified parameters.
      summary: Train a frozen datetime model.
      tags:
      - models
      x-versionadded: v2.6
  /api/v2/projects/{projectId}/frozenModels/:
    get:
      description: List all frozen models from a project.
      operationId: projectsFrozenModels_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: If specified, the returned models will only have scores for this
          metric.  If not, all metrics will be included.
        in: query
        name: withMetric
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrozenModelListResponse'
          description: A list of frozen models in the project.
        '404':
          description: This resource does not exist.
      summary: List all frozen models from a project.
      tags:
      - models
      x-versionadded: v2.5
    post:
      description: "Train a new frozen model with parameters from an existing model.\
        \ Frozen models use tuning parameters from another model on the leaderboard,\
        \ allowing them to be retrained on a larger amount of the training data more\
        \ efficiently. \n To specify the amount of data to use to train the model,\
        \ use either `samplePct` to express a percentage of the rows of the dataset\
        \ to use or `trainingRowCount` to express the number of rows to use. \n If\
        \ neither `samplePct` or `trainingRowCount` is specified, the model will be\
        \ trained on the maximum available training data that can be used to train\
        \ an in-memory model. \n For projects using smart sampling, `samplePct` and\
        \ `trainingRowCount` will be interpreted as a percent or number of rows of\
        \ the minority class. \n When configuring retraining sample sizes for models\
        \ in projects with large row counts, DataRobot recommends requesting sample\
        \ sizes using integer row counts instead of percentages. This is because percentages\
        \ map to many actual possible row counts and only one of which is the actual\
        \ sample size for up to validation. For example, if a project has 199,408\
        \ rows and you request a 64% sample size, any number of rows between 126,625\
        \ rows and 128,618 rows maps to 64% of the data. Using actual integer row\
        \ counts (or `project.max_training_rows`) avoids ambiguity around how many\
        \ rows of data you want the model to use."
      operationId: projectsFrozenModels_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FrozenModelCreate'
      responses:
        '204':
          description: The frozen model has been successfully submitted.
          headers:
            Location:
              description: Contains a url at which the job processing the model can
                be retrieved as with :http:get:`/api/v2/projects/(projectId)/modelJobs/(jobId)/`..
              schema:
                format: url
                type: string
        '404':
          description: This resource does not exist.
        '422':
          description: Unable to process request.
      summary: Train a new frozen model with parameters from an existing model.
      tags:
      - models
      x-versionadded: v2.5
  /api/v2/projects/{projectId}/frozenModels/{modelId}/:
    get:
      description: Look up a particular frozen model. If model with given ID exists
        but it's not frozen, returns 404 Not Found.
      operationId: projectsFrozenModels_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelDetailsResponse'
          description: The frozen model.
        '404':
          description: No such frozen model found.
      summary: Look up a particular frozen model.
      tags:
      - models
      x-versionadded: v2.5
  /api/v2/projects/{projectId}/geometryFeaturePlots/:
    post:
      description: Create a map of one location feature
      operationId: projectsGeometryFeaturePlots_create
      parameters:
      - description: Project Id. It is the project to select the location feature
          from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeometryFeaturePLotCreatePayload'
      responses:
        '202':
          description: Create a map of one location feature
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unprocessed Entity
      summary: Create a map of one location feature
      tags:
      - insights
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/geometryFeaturePlots/{featureName}/:
    get:
      description: Retrieve a map of one location feature
      operationId: projectsGeometryFeaturePlots_retrieve
      parameters:
      - description: Project Id. It is the project to select the feature from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Name of location feature to plot on map. Must be supplied in
          order to determine which plot to retrieve.
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeometryFeaturePlotRetrieveResponse'
          description: Retrieve the map of one location feature
        '404':
          description: Map of feature not found
      summary: Retrieve a map of one location feature
      tags:
      - insights
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/imageActivationMaps/:
    get:
      description: List all Image Activation Maps for the project.
      operationId: projectsImageActivationMaps_list
      parameters:
      - description: The number of items to skip over.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of items to return.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivationMapsListResponse'
          description: Image Activation Maps
      summary: List all Image Activation Maps for the project.
      tags:
      - insights
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/imageBins/:
    get:
      description: List image bins and covers for every target value or range.
      operationId: projectsImageBins_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Name of the image feature
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBinsListResponse'
          description: Returns a list of image metadata
        '422':
          description: The request cannot be processed
      summary: List image bins and covers for every target value or range.
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/imageEmbeddings/:
    get:
      description: List all Image Embeddings for the project.
      operationId: projectsImageEmbeddings_list
      parameters:
      - description: The number of items to skip over.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of items to return.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingsListResponse'
          description: Image Embeddings
      summary: List all Image Embeddings for the project.
      tags:
      - insights
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/imageSamples/:
    get:
      description: List all metadata for images in the EDA sample
      operationId: projectsImageSamples_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Name of the image feature
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataListResponse'
          description: Paginated list of image metadata
        '422':
          description: The request cannot be processed
      summary: List all metadata for images in the EDA sample
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/images/:
    get:
      description: Returns a list of image metadata elements.
      operationId: projectsImages_list
      parameters:
      - description: Name of the column to query
        in: query
        name: column
        required: false
        schema:
          type: string
      - description: For classification projects - when specified, only images corresponding
          to this target value will be returned. Mutually exclusive with targetBinStart/targetBinEnd.
        in: query
        name: targetValue
        required: false
        schema:
          anyOf:
          - type: number
          - type: string
      - description: For regression projects - when specified, only images corresponding
          to the target values above this will be returned. Mutually exclusive with
          targetValue. Must be specified with targetBinEnd.
        in: query
        name: targetBinStart
        required: false
        schema:
          anyOf:
          - type: number
          - type: string
      - description: For regression projects - when specified, only images corresponding
          to the target values below this will be returned. Mutually exclusive with
          targetValue. Must be specified with targetBinStart.
        in: query
        name: targetBinEnd
        required: false
        schema:
          anyOf:
          - type: number
          - type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 100
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataListResponse'
          description: Returns a list of image metadata elements.
        '422':
          description: 'The request cannot be processed. Possible reasons include:
            - Cannot supply value for both TargetValue and TargetBin. - Must supply
            both TargetBinStart and TargetBinEnd. - TargetBin parameters are only
            valid for regression projects. - TargetValue parameter is only valid for
            classification projects.'
      summary: Returns a list of image metadata elements.
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/images/{imageId}/:
    get:
      description: Returns a single image metadata.
      operationId: projectsImages_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Id of the image
        in: path
        name: imageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataResponse'
          description: Metadata for a single image
        '404':
          description: Image not found
      summary: Returns a single image metadata.
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/images/{imageId}/file/:
    get:
      description: Returns a file for a single image
      operationId: projectsImagesFile_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Id of the image
        in: path
        name: imageId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response is an image file (not JSON) that can be saved
            or displayed.
        '404':
          description: Image not found
      summary: Returns a file for a single image
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/imagesDataQualityLog/:
    get:
      description: Retrieve the images data quality log content and log length as
        JSON
      operationId: projectsImagesDataQualityLog_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImagesDataQualityLogLinesResponse'
          description: Paginated list of lines of the image data quality log
        '422':
          description: Not a data quality enabled project
      summary: Retrieve the images data quality log content and log length as JSON
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/imagesDataQualityLog/file/:
    get:
      description: Retrieve a text file containing the images data quality log
      operationId: projectsImagesDataQualityLogFile_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a text file with the contents of
            the images data quality log.
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - text/plain
                type: string
      summary: Retrieve a text file containing the images data quality log
      tags:
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/incrementalLearningModels/fromModel/:
    post:
      description: Train a new incremental learning model based on an existing model
        and external data, that was not seen during partitioning.
      operationId: projectsIncrementalLearningModelsFromModel_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainIncrementalLearningModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRetrainResponse'
          description: Incremental learning model submission response
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Train a new incremental learning model based on an existing model and
        external data, that was not seen during partitioning.
      tags:
      - models
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables Incremental Learning. This allows model retraining to
          continue with an infinite amount of data.
        enabled_by_default: false
        maturity: PUBLIC_PREVIEW
        name: INCREMENTAL_LEARNING
  /api/v2/projects/{projectId}/jobs/:
    get:
      description: List the project's jobs.
      operationId: projectsJobs_list
      parameters:
      - description: If provided, only jobs with the same status will be included
          in the results; otherwise, queued and inprogress jobs (but not errored jobs)
          will be returned.
        in: query
        name: status
        required: false
        schema:
          enum:
          - queue
          - inprogress
          - error
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResponse'
          description: The project's jobs
      summary: List project jobs
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/jobs/{jobId}/:
    delete:
      description: Cancel a pending job.
      operationId: projectsJobs_delete
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The job ID
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The job has been canceled.
      summary: Cancel Job
      tags:
      - projects
      x-versionadded: v2.3
    get:
      description: Retrieve details for a job that has been started but has not yet
        completed.
      operationId: projectsJobs_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The job ID
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDetailsResponse'
          description: The job details
        '303':
          description: The requested job has already finished. See the Location header
            for the job details.
      summary: Get job
      tags:
      - projects
      x-versionadded: v2.3
  /api/v2/projects/{projectId}/modelJobs/:
    get:
      description: List modeling jobs.
      operationId: projectsModelJobs_list
      parameters:
      - description: If provided, only jobs with the same status will be included
          in the results; otherwise, queued and inprogress jobs (but not errored jobs)
          will be returned.
        in: query
        name: status
        required: false
        schema:
          enum:
          - queue
          - inprogress
          - error
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ModelingJobListResponse'
                type: array
          description: List of modeling jobs.
      summary: List modeling jobs
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/modelJobs/{jobId}/:
    delete:
      description: Cancel a modeling job
      operationId: projectsModelJobs_delete
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The job ID
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The job has been successfully cancelled.
        '404':
          description: no job with jobId found, or the job has already completed
      summary: Cancel a modeling job.
      tags:
      - models
      x-versionadded: v2.0
    get:
      description: Look up a particular modeling job
      operationId: projectsModelJobs_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The job ID
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelJobResponse'
          description: A modeling job
          headers:
            Location:
              description: if a status code 303 was returned, will contain a url at
                which the completed model can be retrieved`
              schema:
                format: url
                type: string
        '303':
          description: Task is completed, see Location header for the location of
            a new resource
      summary: Look up a specific modeling job
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/modelRecords/:
    get:
      description: Retrieve model records, supports filtering and search
      operationId: projectsModelRecords_list
      parameters:
      - description: If specified, the returned models will only have scores for this
          metric. If not, all metrics will be included.
        in: query
        name: withMetric
        required: false
        schema:
          type: string
      - description: If specified, will return metric scores for models trained into
          validation/holdout for projects that do not have stacked predictions.
        in: query
        name: showInSampleScores
        required: false
        schema:
          default: false
          type: boolean
        x-versionadded: v2.31
      - description: A characteristics to filter models with. Only those models which
          have all specified characteristics are returned.
        in: query
        name: characteristics
        required: false
        schema:
          items:
            enum:
            - frozen
            - trained on gpu
            - with exportable coefficients
            - with mono constraints
            - with rating table
            - with scoring code
            type: string
          type: array
      - description: Filter models by the string expression in the description, case
          insensitive.
        in: query
        name: searchTerm
        required: false
        schema:
          maxLength: 300
          type: string
      - description: Filter models by labels. Only those models which have all specified
          labels are returned.
        in: query
        name: labels
        required: false
        schema:
          items:
            enum:
            - prepared for deployment
            - starred
            type: string
          type: array
      - description: Filter models by blueprint ids.
        in: query
        name: blueprints
        required: false
        schema:
          type: string
      - description: Filter models by families.
        in: query
        name: families
        required: false
        schema:
          items:
            enum:
            - Adaptive Boosting
            - Anomaly Detection
            - Blender
            - Calibrator
            - Clustering
            - Custom
            - Decision Tree
            - Document
            - Naive
            - ElasticNet Generalized Linear Model
            - Eureqa
            - Eureqa Time-Series
            - External Prediction Model
            - Factorization Machine
            - Generalized Additive Model
            - Generalized Linear Model
            - Gradient Boosting Machine
            - Image
            - K Nearest Neighbors
            - Naive Bayes
            - Neural Network
            - Other
            - Random Forest
            - Rule Induction
            - Summarized Categorical
            - Support Vector Machine
            - Text Mining
            - Time-Series Neural Network
            - Traditional Time-Series
            - Two Stage
            - Vowpal Wabbit
            type: string
          type: array
      - description: Filter models by featurelist names.
        in: query
        name: featurelists
        required: false
        schema:
          type: string
      - description: 'Filter models by training length or type. Could be training
          duration in string representation, ''Start/end date'', ''Project settings''
          constants or number of rows. Training duration for datetime partitioned
          projects may have up to three parts: <training_duration>-<time_window_sample_percent>-<sampling_method>.Example
          of the training duration: `P6Y0M0D-78-Random`, returns models trained on6
          years, with sampling rate 78%, randomly taken from the training window.
          Example of the row count with sampling method: `150-Random`'
        in: query
        name: trainingFilters
        required: false
        schema:
          type: string
      - description: Metric to order models by. If omitted, the project metric is
          used.
        in: query
        name: sortByMetric
        required: false
        schema:
          maxLength: 100
          type: string
      - description: Partition to use when ordering models by metric. If omitted,
          the validation partition is used.
        in: query
        name: sortByPartition
        required: false
        schema:
          enum:
          - backtesting
          - crossValidation
          - validation
          - holdout
          type: string
      - description: Number of results that are skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Maximum number of models to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 500
          minimum: 0
          type: integer
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRecordsResponse'
          description: ''
      summary: Retrieve model records, supports filtering and search
      tags:
      - models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables access to the new Leaderboard retrieval endpoint.
        enabled_by_default: true
        maturity: GA_ALL
        name: NEW_LEADERBOARD_RETRIEVAL_ENDPOINT
      x-versionadded: v2.33
  /api/v2/projects/{projectId}/modelingFeaturelists/:
    get:
      description: 'List all modeling featurelists from the project requested by ID.

        This route will only become available after the target and partitioning options
        have been set for a project.

        Modeling featurelists are featurelists of modeling features, and are the correct
        featurelists to use when creating models or restarting the autopilot. In a
        time series project, these will differ from those returned from :http:get:`/api/v2/projects/(projectId)/featurelists/`
        while in other projects these will be identical. See the :ref:`documentation
        <input_vs_modeling>` for more information on the distinction between input
        and modeling data in time series projects.'
      operationId: projectsModelingFeaturelists_list
      parameters:
      - description: Property to sort featurelists by in the response
        in: query
        name: sortBy
        required: false
        schema:
          enum:
          - name
          - description
          - features
          - numModels
          - created
          - isUserCreated
          - -name
          - -description
          - -features
          - -numModels
          - -created
          - -isUserCreated
          type: string
      - description: Limit results by specific featurelists. Performs a substring
          search for the term you provide in featurelist names.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistListResponse'
          description: List of requested project modeling featurelists.
      summary: List all modeling featurelists from a project
      tags:
      - projects
      x-versionadded: v2.8
    post:
      description: 'Create new modeling featurelist from list of feature names.

        Only time series projects differentiate between modeling and input featurelists.
        On other projects, this route will behave the same as :http:post:`/api/v2/projects/(projectId)/featurelists/`.

        On time series projects, this can be used after the target has been set in
        order to create a new featurelist on the modeling features, although the previously
        mentioned route for creating featurelists will be disabled. On time series
        projects, only modeling features may be passed to this route to create a featurelist.'
      operationId: projectsModelingFeaturelists_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFeaturelist'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistResponse'
          description: The newly created featurelist in the same format as :http:get:`/api/v2/projects/(projectId)/modelingFeaturelists/(featurelistId)/`.
      summary: Create a new modeling featurelist.
      tags:
      - projects
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/:
    delete:
      description: 'Delete a specified modeling featurelist.

        All models using a featurelist, whether as the training featurelist or as
        a monotonic constraint featurelist, will also be deleted when the deletion
        is executed and any queued or running jobs using it will be cancelled. Similarly,
        predictions made on these models will also be deleted. All the entities that
        are to be deleted with a featurelist are described as "dependencies" of it.
        When deleting a featurelist with dependencies, users must pass an additional
        query parameter `deleteDependencies` to confirm they want to delete the featurelist
        and all its dependencies. Without that option, only featurelists with no dependencies
        may be successfully deleted.

        Featurelists configured into the project as a default featurelist or as a
        default monotonic constraint featurelist cannot be deleted.

        Featurelists used in a model deployment cannot be deleted until the model
        deployment is deleted.

        Modeling featurelists are featurelists of modeling features, and are the appropriate
        featurelists to use when creating models or restarting the autopilot. In a
        time series project, these will be distinct from those returned from :http:get:`/api/v2/projects/(projectId)/featurelists/`
        while in other projects these will be identical.'
      operationId: projectsModelingFeaturelists_delete
      parameters:
      - description: Preview the deletion results without actually deleting the featurelist.
        in: query
        name: dryRun
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Automatically delete all dependencies of a featurelist. If false
          (default), will only delete the featurelist if it has no dependencies. The
          value of deleteDependencies will not be used if dryRun is true.If a featurelist
          has dependencies, deleteDependencies must be true for the request to succeed.
        in: query
        name: deleteDependencies
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The featurelist ID.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistDestroyResponse'
          description: ''
      summary: Delete a specified modeling featurelist.
      tags:
      - projects
      x-versionadded: v2.13
    get:
      description: 'Retrieve a single modeling featurelist by ID.

        When reporting the number of models that "use" a featurelist, a model is considered
        to use a featurelist if it is used as to train the model or as a monotonic
        constraint featurelist, or if the model is a blender with component models
        that use the featurelist.

        This route will only become available after the target and partitioning options
        have been set for a project.

        Modeling featurelists are featurelists of modeling features, and are the appropriate
        featurelists to use when creating models or restarting the autopilot. In a
        time series project, these will be distinct from those returned from :http:get:`/api/v2/projects/(projectId)/featurelists/`
        while in other projects these will be identical.'
      operationId: projectsModelingFeaturelists_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The featurelist ID.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturelistResponse'
          description: Modeling featurelist with specified ID.
      summary: Retrieve a single modeling featurelist by ID
      tags:
      - projects
      x-versionadded: v2.8
    patch:
      description: 'Update an existing modeling featurelist by ID.

        In non-time series projects, "modeling featurelists" and "featurelists" routes
        behave the same, except "modeling featurelists" are only accessible after
        the project is ready for modeling.  In time series projects, "featurelists"
        contain the input features before feature derivation that are used to derive
        the time series features, while  "modeling featurelists" contain the derived
        time series features used for modeling.'
      operationId: projectsModelingFeaturelists_patch
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The featurelist ID.
        in: path
        name: featurelistId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFeaturelist'
      responses:
        '204':
          description: The modeling featurelist was successfully updated.
        '422':
          description: Update failed due to an invalid payload. This may be because
            the name is identical to an existing featurelist name.
      summary: Update an existing modeling featurelist
      tags:
      - projects
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/modelingFeatures/:
    get:
      description: List the features from a project that are used for modeling with
        descriptive information.
      operationId: projectsModelingFeatures_list
      parameters:
      - description: Property to sort features by in the response
        in: query
        name: sortBy
        required: false
        schema:
          enum:
          - name
          - id
          - importance
          - featureType
          - uniqueCount
          - naCount
          - mean
          - stdDev
          - median
          - min
          - max
          - -name
          - -id
          - -importance
          - -featureType
          - -uniqueCount
          - -naCount
          - -mean
          - -stdDev
          - -median
          - -min
          - -max
          type: string
      - description: Limit results by specific features. Performs a substring search
          for the term you provide in featurelist names.
        in: query
        name: searchFor
        required: false
        schema:
          type: string
      - description: Filter features by a specific featurelist ID.
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelingFeatureListResponse'
          description: Descriptive information for features.
        '422':
          description: Unable to process the request
      summary: List project modeling features.
      tags:
      - projects
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/modelingFeatures/fromDiscardedFeatures/:
    post:
      description: Restore discarded time series features.
      operationId: projectsModelingFeaturesFromDiscardedFeatures_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelingFeaturesCreateFromDiscarded'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelingFeaturesCreateFromDiscardedResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '404':
          description: No discarded time series features information available.
        '422':
          description: Unable to process the request.
      summary: Restore discarded time series features.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/modelingFeatures/{featureName}/:
    get:
      description: Retrieve the specified modeling feature with descriptive information.
      operationId: projectsModelingFeatures_retrieve
      parameters:
      - description: The ID of the project
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: 'the name of the feature Note: DataRobot renames some features,
          so the feature name may not be the one from your original data. You can
          use :http:get:`/api/v2/projects/(projectId)/features/` to list the features
          and check the name. Note to users with non-ascii features names: The feature
          name should be utf-8-encoded (before URL-quoting) '
        in: path
        name: featureName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelingFeatureResponse'
          description: Descriptive information for feature.
        '404':
          description: Feature does not exist.
        '422':
          description: Unable to process the request
      summary: Retrieve project modeling feature.
      tags:
      - projects
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/models/:
    get:
      description: Lists all the models from a project.
      operationId: projectsModels_list
      parameters:
      - description: If specified, the returned models will only have scores for this
          metric. If not, all metrics will be included.
        in: query
        name: withMetric
        required: false
        schema:
          type: string
      - description: If specified, will return metric scores for models trained into
          validation/holdout for projects that do not have stacked predictions.
        in: query
        name: showInSampleScores
        required: false
        schema:
          default: false
          type: boolean
        x-versionadded: v2.31
      - description: If specified, filters for models with a model type matching `name`.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: If specified, filters for models with a matching sample percentage.
        in: query
        name: samplePct
        required: false
        schema:
          type: number
      - description: If specified, filters for models marked as starred.
        in: query
        name: isStarred
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.13
      - description: A comma-separated list of metrics to sort by. If metric is prefixed
          with a '-', models are sorted by this metric in descending order, otherwise
          are sorted in ascending order. Valid sorting metrics are `metric` and `samplePct`.
          Use of `metric` sorts models by metric value selected for this project using
          the validation score. Use of the prefix accounts for the direction of the
          metric, so `-metric` will sort in order of decreasing 'goodness', which
          may be opposite to the natural numerical order. If not specified, `-metric`
          will be used.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - metric
          - -metric
          - samplePct
          - -samplePct
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ModelDetailsResponse'
                type: array
          description: The project's models
      summary: List project models
      tags:
      - models
      x-versionadded: v2.0
    post:
      description: "Train a new model. To specify the amount of data to use to train\
        \ the model, use either `samplePct` to express a percentage of the rows of\
        \ the dataset to use or `trainingRowCount` to express the number of rows to\
        \ use. If neither `samplePct` or `trainingRowCount` is specified, the model\
        \ will be trained on the maximum available training data that can be used\
        \ to train an in-memory model. For projects using smart sampling, samplePct\
        \ and trainingRowCount will be interpreted as a percent or number of rows\
        \ of the minority class. \n When configuring retraining sample sizes for models\
        \ in projects with large row counts, DataRobot recommends requesting sample\
        \ sizes using integer row counts instead of percentages. This is because percentages\
        \ map to many actual possible row counts and only one of which is the actual\
        \ sample size for up to validation. For example, if a project has 199,408\
        \ rows and you request a 64% sample size, any number of rows between 126,625\
        \ rows and 128,618 rows maps to 64% of the data. Using actual integer row\
        \ counts (or `project.max_training_rows`) avoids ambiguity around how many\
        \ rows of data you want the model to use."
      operationId: projectsModels_create
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainModel'
      responses:
        '202':
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Could not create new job
      summary: Train a new model
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/models/fromModel/:
    post:
      description: 'Retrain an existing model using a new sample size and/or feature
        list.When configuring retraining sample sizes for models in projects with
        large row counts, DataRobot recommends requesting sample sizes using integer
        row counts instead of percentages. This is because percentages map to many
        actual possible row counts and only one of which is the actual sample size
        for up to validation. For example, if a project has 199,408 rows and you request
        a 64% sample size, any number of rows between 126,625 rows and 128,618 rows
        maps to 64% of the data. Using actual integer row counts (or `project.max_training_rows`)
        avoids ambiguity around how many rows of data you want the model to use.

        Note that only one of `samplePct` or `trainingRowCount` should be specified.'
      operationId: projectsModelsFromModel_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrainModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRetrainResponse'
          description: Retrain an existing model using a new sample size and/or feature
            list.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: model with specified `modelId` is deprecated, or it doesn't
            support retraining using a new sample size and/or feature list
      summary: Retrain a model
      tags:
      - models
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/models/{modelId}/:
    delete:
      description: Delete a model from the leaderboard
      operationId: projectsModels_delete
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The model has been successfully deleted.
        '404':
          description: This resource does not exist.
        '422':
          description: Unable to process the request.
      summary: Delete a model from the leaderboard.
      tags:
      - models
      x-versionadded: v2.0
    get:
      description: Look up a particular model.
      operationId: projectsModels_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelDetailsResponse'
          description: The model
      summary: Get model
      tags:
      - models
      x-versionadded: v2.0
    patch:
      description: Updates a model's attribute(s)
      operationId: projectsModels_patch
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelUpdate'
      responses:
        '204':
          description: The model has been successfully updated with new attributes.
        '404':
          description: This resource does not exist.
        '422':
          description: Unable to process the request.
      summary: Updates a model's attribute(s).
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/models/{modelId}/advancedTuning/:
    post:
      description: 'Submit a job to make a new version of the model with different
        advanced tuning parameters. Note: This route currently supports all models
        other than: OSS, blenders, prime, scaleout, baseline and user-created. Currently,
        only single-stage models (most simple models) are supported. Blueprints that
        run multiple steps, for example one step to predict zero vs nonzero and a
        second step to determine the value of nonzero predictions, are not supported.
        (:ref:`Advanced Tuning documentation <grid_search>`). Parameters may be omitted
        from this endpoint. If a parameter is omitted, its `currentValue` will be
        used. To see the possible parameter IDs and constraints on possible values,
        see :http:get:`/api/v2/projects/(projectId)/models/(modelId)/advancedTuning/parameters/`.'
      operationId: projectsModelsAdvancedTuning_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelAdvancedTuning'
      responses:
        '202':
          description: The job has been successfully submitted. See the Location header.
          headers:
            Location:
              description: A url at which the job processing the model can be retrieved.
              schema:
                format: url
                type: string
        '403':
          description: Permission denied creating advanced tuned model
        '404':
          description: This resource does not exist.
        '413':
          description: Tuning request is too large
        '422':
          description: Could not create new job.
      summary: Submit a job to make a new version of the model with different advanced
        tuning parameters.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/models/{modelId}/advancedTuning/parameters/:
    get:
      description: 'Retrieve information about all advanced tuning parameters available
        for the specified model. Note: This route currently supports all models other
        than: OSS, blenders, prime, scaleout, baseline and user-created'
      operationId: projectsModelsAdvancedTuningParameters_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvancedTuningArgumentsRetrieveResponse'
          description: The information about all advanced tuning parameters available
            for the specified model.
        '403':
          description: Permission denied creating advanced tuned model.
        '404':
          description: This resource does not exist.
        '422':
          description: This model does not support advanced tuning.
      summary: Retrieve information about all advanced tuning parameters available
        for the specified model.
      tags:
      - models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/models/{modelId}/anomalyAssessmentInitialization/:
    post:
      description: Initialize the anomaly assessment insight and calculate Shapley
        explanations for the most anomalous points in the subset. The insight is available
        for anomaly detection models in time series unsupervised projects which also
        support calculation of Shapley values.
      operationId: projectsModelsAnomalyAssessmentInitialization_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnomalyAssessmentInitialize'
      responses:
        '202':
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Calculate the anomaly assessment insight.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsFile/:
    get:
      description: Retrieve a CSV file of the raw data displayed with the anomaly
        score from the specific model. The number of rows included will be set by
        the expected outlier fraction but up to a maximum of 1000 rows. Only models
        built from anomaly detection blueprints have those insights.
      operationId: projectsModelsAnomalyInsightsFile_list
      parameters:
      - description: name of the file to generate and return
        in: query
        name: filename
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieve a CSV file of the raw data displayed with the anomaly
            score from the model.
        '404':
          description: project Id / model Id does not exist or model doesn't have
            anomaly insights table.
      summary: Retrieve a CSV file of the raw data displayed with the anomaly score
        from the model.
      tags:
      - insights
      x-versionadded: v2.20
  /api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsTable/:
    get:
      description: Retrieve a table of the raw data displayed with the anomaly score
        from the specific model. The number of rows displayed is limited to 100 rows
        by the ANOMALY_INSIGHT_SAMPLE_ROW_COUNT configuration setting. Additionally,
        feature column count and the size of data in text fields is also limited.
        Only models built from anomaly detection blueprints have those insights.
      operationId: projectsModelsAnomalyInsightsTable_list
      parameters:
      - description: number of decimals each element anomalyScore column will be rounded
          to.
        in: query
        name: anomalyScoreRounding
        required: false
        schema:
          exclusiveMinimum: true
          maximum: 12
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyInsightTableRetrieve'
          description: Retrieve a table of the raw data displayed with the anomaly
            score from the specific model.
        '404':
          description: The model doesn't have anomaly insights table.
      summary: Retrieve a table of the raw data displayed with the anomaly score from
        the specific model.
      tags:
      - insights
      x-versionadded: v2.20
  /api/v2/projects/{projectId}/models/{modelId}/blueprintChart/:
    get:
      description: Retrieve a reduced model blueprint chart by model id. The model
        blueprint charts are reduced from the full blueprint charts to show only those
        sections of the blueprint that were actually used in the model, given the
        selected featurelist.
      operationId: projectsModelsBlueprintChart_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlueprintChartRetrieveResponse'
          description: A reduced model blueprint chart based on the model id.
        '404':
          description: No model found for given projectId and modelId.
      summary: Retrieve a reduced model blueprint chart by model id.
      tags:
      - blueprints
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/models/{modelId}/blueprintDocs/:
    get:
      description: Retrieve task documentation for a reduced model blueprint. The
        model blueprint is reduced from the full blueprint to show only those sections
        of the blueprint that were actually used in the model, given the selected
        featurelist.
      operationId: projectsModelsBlueprintDocs_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BlueprintListDocumentsResponse'
                type: array
          description: The task documentation for a reduced model blueprint.
        '404':
          description: No model found for given projectId and modelId.
      summary: Retrieve task documentation for a reduced model blueprint.
      tags:
      - blueprints
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/models/{modelId}/clusterInsights/:
    get:
      description: Retrieve all computed Cluster Insights for a clustering project
        model.
      operationId: projectsModelsClusterInsights_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 15
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Order results by the specified field value.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - featureImpact
          - -featureImpact
          - featureName
          - -featureName
          type: string
      - description: Search for a specific string in a feature name.This search is
          case insensitive. If not specified, all features will be returned.
        in: query
        name: searchFor
        required: false
        schema:
          maxLength: 100
          minLength: 1
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterInsightsPaginatedResponse'
          description: Insights for a clustering project model.
        '404':
          description: The project or the model was not found or insights have not
            been computed yet.
        '422':
          description: Feature Impact is required. Please, compute it first.
      summary: Retrieve Cluster Insights for all features.
      tags:
      - insights
      x-versionadded: v2.27
    post:
      description: Compute Cluster Insights for a clustering project model.The number
        of features computed for cluster insights are capped at 100, starting with
        the features used to train the model sorted by feature impact (high to low),
        and then the remaining features in the dataset alphabetically.
      operationId: projectsModelsClusterInsights_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Empty'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
          description: A URI of the newly submitted job in the "Location" header.
        '404':
          description: The project or the model was not found or insights have not
            been computed yet.
        '422':
          description: Feature Impact is already in progress or Cluster Insighst is
            already in progress, but we were unable to find the previous job.
      summary: Compute Cluster Insights.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/clusterInsights/download/:
    get:
      description: Download all computed Cluster Insights for a clustering project
        model.
      operationId: projectsModelsClusterInsightsDownload_list
      parameters:
      - description: A format to use.
        in: query
        name: format
        required: false
        schema:
          default: CSV
          enum:
          - CSV
          type: string
      - description: The ID of the featurelist to download data for. If not specified
          all columns will be downloaded.
        in: query
        name: featurelistId
        required: false
        schema:
          nullable: true
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A file with insights for a clustering project model.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download ("attachment;filename=cluster_insights_<project_id>_<model_id>.csv").
              schema:
                type: string
        '404':
          description: The project or the model was not found or insights have not
            been computed yet.
        '422':
          description: Feature Impact is required. Please, compute it first.
      summary: Download Cluster Insights result.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/clusterNames/:
    get:
      description: Retrieve all cluster names assigned to an unsupervised cluster
        model
      operationId: projectsModelsClusterNames_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterNamesResponse'
          description: Retrieve all cluster names for the model
        '404':
          description: 'Could not find unsupervised clustering model. Possible reasons
            include: 1. Provided model id points to a model that does not exist in
            specified project. 2. Provided model has incompatible type. Method requires
            model to be unsupervised clustering model.'
      summary: Retrieve cluster names assigned to an unsupervised cluster model
      tags:
      - models
      x-versionadded: v2.27
    patch:
      description: Update and then retrieve all cluster names assigned to an unsupervised
        cluster model
      operationId: projectsModelsClusterNames_patchMany
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterNamesUpdateParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterNamesResponse'
          description: Update cluster names and then retrieve all cluster names for
            the model
        '404':
          description: 'Could not find unsupervised clustering model. Possible reasons
            include: 1. Provided model id points to a model which does not exists
            in specified project. 2. Provided model has incompatible type. Method
            requires model to be unsupervised clustering model.'
        '422':
          description: 'The request cannot be processed. Possible reasons include:
            1. Mapping contains invalid current cluster name and referenced cluster
            was not found. 2. Mapping is invalid as after update, clusters will not
            be uniquely identifiable by name.'
      summary: Update cluster names assigned to an unsupervised cluster model
      tags:
      - models
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/:
    get:
      description: "\n        Retrieve all available confusion charts for model. The\
        \ response will\n        include a json array of all available confusion charts,\
        \ in the same format as the response\n        from :http:get:`/api/v2/projects/(projectId)/models/(modelId)/confusionCharts/(source)/`.\n\
        \        .. note:: Available for multiclass projects only.\n        "
      operationId: projectsModelsConfusionCharts_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelConfusionChartListResponse'
          description: All of the available confusion charts for a model.
        '404':
          description: No confusion chart available.
      summary: Retrieve all available confusion charts for model.
      tags:
      - insights
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/:
    get:
      description: "\n        Retrieve the confusion chart data from a single source.\
        \ A confusion chart consists of the confusion matrix for all classes, classes\
        \ frequencies and `oneVsAll` metrics for all classes. The confusion matrix\
        \ can be requested in a particular sort order and orientated by rows or columns.\
        \ A subset of the confusion matrix can also be requested in part by specifying\
        \ slicing indices. Throughout the following specification, `C` refers to the\
        \ total number of classes in the dataset. The full confusion matrix refers\
        \ to the confusion matrix with `C` classes.\n\n        .. note:: Available\
        \ for multiclass projects only.\n\n        An example on the meaning of wasActualPercentages\
        \ and wasPredictedPercentages:\n        Let's say we have the following data:\n\
        \        .. code-block:: js\n\n           \n           classMetrics.classA.wasActualPercentages[0].percentage\
        \ = 0.56\n           classMetrics.classA.wasPredictedPercentages[0].percentage\
        \ = 0.62\n           classA.wasActualPercentages[0].otherClassName = \"classB\"\
        \n           classA.wasPredictedPercentages[0].otherClassName = \"classB\"\
        \n    \n\n        That means:\n\n        1) \"Given that it was actually classA,\
        \ it predicted classB 56% of the time\".\n        2) \"Given that classA was\
        \ predicted, it was actually classB 62% of the time\".\n        "
      operationId: projectsModelsConfusionCharts_retrieve
      parameters:
      - description: Ordering the chart data by following attributes.Prefix the attribute
          name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
        in: query
        name: orderBy
        required: false
        schema:
          default: className
          enum:
          - className
          - -className
          - actualCount
          - -actualCount
          - predictedCount
          - -predictedCount
          - f1
          - -f1
          - precision
          - -precision
          - recall
          - -recall
          type: string
      - description: Determines whether the values in the rows of the confusion matrix
          should correspond to the same actual class ('actual') or predicted class
          ('predicted').
        in: query
        name: orientation
        required: false
        schema:
          default: actual
          enum:
          - actual
          - -actual
          - predicted
          - -predicted
          type: string
      - description: start index of row for slicing the confusion matrix.
        in: query
        name: rowStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: end index of row for slicing the confusion matrix.
        in: query
        name: rowEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: start index of column for slicing the confusion matrix.
        in: query
        name: colStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: end index of column for slicing the confusion matrix.
        in: query
        name: colEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
        x-enum-versionadded:
        - value: backtest_2
          x-versionadded: v2.23
        - value: backtest_3
          x-versionadded: v2.23
        - value: backtest_4
          x-versionadded: v2.23
        - value: backtest_5
          x-versionadded: v2.23
        - value: backtest_6
          x-versionadded: v2.23
        - value: backtest_7
          x-versionadded: v2.23
        - value: backtest_8
          x-versionadded: v2.23
        - value: backtest_9
          x-versionadded: v2.23
        - value: backtest_10
          x-versionadded: v2.23
        - value: backtest_11
          x-versionadded: v2.23
        - value: backtest_12
          x-versionadded: v2.23
        - value: backtest_13
          x-versionadded: v2.23
        - value: backtest_14
          x-versionadded: v2.23
        - value: backtest_15
          x-versionadded: v2.23
        - value: backtest_16
          x-versionadded: v2.23
        - value: backtest_17
          x-versionadded: v2.23
        - value: backtest_18
          x-versionadded: v2.23
        - value: backtest_19
          x-versionadded: v2.23
        - value: backtest_20
          x-versionadded: v2.23
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelConfusionChartRetrieveResponse'
          description: The confusion chart data from a single source.
        '404':
          description: No confusion chart for source.
        '422':
          description: Invalid indices for confusion matrix.
      summary: Retrieve the confusion chart data from a single source.
      tags:
      - insights
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/classDetails/:
    get:
      description: "\n        Calculates and sends frequency of class in distributed\
        \ among other\n        classes for actual and predicted data. A confusion\
        \ chart class details for given class gives\n        stats of misclassification\
        \ done by model for given class for actual and predicted data.\n        ..\
        \ note:: Available for multiclass projects only.\n        "
      operationId: projectsModelsConfusionChartsClassDetails_list
      parameters:
      - description: Name of a class for which distribution frequency is requested.
        in: query
        name: className
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
        x-enum-versionadded:
        - value: backtest_2
          x-versionadded: v2.23
        - value: backtest_3
          x-versionadded: v2.23
        - value: backtest_4
          x-versionadded: v2.23
        - value: backtest_5
          x-versionadded: v2.23
        - value: backtest_6
          x-versionadded: v2.23
        - value: backtest_7
          x-versionadded: v2.23
        - value: backtest_8
          x-versionadded: v2.23
        - value: backtest_9
          x-versionadded: v2.23
        - value: backtest_10
          x-versionadded: v2.23
        - value: backtest_11
          x-versionadded: v2.23
        - value: backtest_12
          x-versionadded: v2.23
        - value: backtest_13
          x-versionadded: v2.23
        - value: backtest_14
          x-versionadded: v2.23
        - value: backtest_15
          x-versionadded: v2.23
        - value: backtest_16
          x-versionadded: v2.23
        - value: backtest_17
          x-versionadded: v2.23
        - value: backtest_18
          x-versionadded: v2.23
        - value: backtest_19
          x-versionadded: v2.23
        - value: backtest_20
          x-versionadded: v2.23
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelConfusionChartClassDetailsRetrieveReponseController'
          description: The details of the confusion matrix of a model for a specific
            class.
        '404':
          description: No confusion chart for source.
      summary: Calculates and sends frequency of class in distributed among other
        classes for actual and predicted data.
      tags:
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/metadata/:
    get:
      description: "\n        Retrieve metadata for the confusion chart of a model.\n\
        \        .. note:: Available for multiclass projects only.\n        "
      operationId: projectsModelsConfusionChartsMetadata_list
      parameters:
      - description: Ordering the chart data by following attributes.Prefix the attribute
          name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
        in: query
        name: orderBy
        required: false
        schema:
          default: className
          enum:
          - className
          - -className
          - actualCount
          - -actualCount
          - predictedCount
          - -predictedCount
          - f1
          - -f1
          - precision
          - -precision
          - recall
          - -recall
          type: string
      - description: Determines whether the values in the rows of the confusion matrix
          should correspond to the same actual class ('actual') or predicted class
          ('predicted').
        in: query
        name: orientation
        required: false
        schema:
          default: actual
          enum:
          - actual
          - -actual
          - predicted
          - -predicted
          type: string
      - description: Number of classes in a single 'thumbnail' cell.
        in: query
        name: thumbnailCellSize
        required: false
        schema:
          default: 10
          exclusiveMinimum: true
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
        x-enum-versionadded:
        - value: backtest_2
          x-versionadded: v2.23
        - value: backtest_3
          x-versionadded: v2.23
        - value: backtest_4
          x-versionadded: v2.23
        - value: backtest_5
          x-versionadded: v2.23
        - value: backtest_6
          x-versionadded: v2.23
        - value: backtest_7
          x-versionadded: v2.23
        - value: backtest_8
          x-versionadded: v2.23
        - value: backtest_9
          x-versionadded: v2.23
        - value: backtest_10
          x-versionadded: v2.23
        - value: backtest_11
          x-versionadded: v2.23
        - value: backtest_12
          x-versionadded: v2.23
        - value: backtest_13
          x-versionadded: v2.23
        - value: backtest_14
          x-versionadded: v2.23
        - value: backtest_15
          x-versionadded: v2.23
        - value: backtest_16
          x-versionadded: v2.23
        - value: backtest_17
          x-versionadded: v2.23
        - value: backtest_18
          x-versionadded: v2.23
        - value: backtest_19
          x-versionadded: v2.23
        - value: backtest_20
          x-versionadded: v2.23
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelConfusionChartMetadataRetrieveResponse'
          description: The metadata for the confusion chart of a model.
        '404':
          description: No confusion chart for source.
      summary: Retrieve metadata for the confusion chart of a model.
      tags:
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/:
    get:
      description: Retrieves a list of Cross Class Accuracy scores for the model.
      operationId: projectsModelsCrossClassAccuracyScores_list
      parameters:
      - description: Number of items to skip. Defaults to 0 if not provided.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of items to return, defaults to 100 if not provided.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossClassAccuracyList'
          description: Returns Cross Class Accuracy scores.
      summary: List Cross Class Accuracy scores.
      tags:
      - insights
      x-versionadded: v2.25
    post:
      description: Submits a job to start Cross Class Accuracy scores calculations
        for the model.
      operationId: projectsModelsCrossClassAccuracyScores_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossClassAccuracyCreateResponse'
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Start Cross Class Accuracy calculations.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/models/{modelId}/crossValidation/:
    post:
      description: Run Cross Validation on a model.
      operationId: projectsModelsCrossValidation_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Empty'
      responses:
        '202':
          description: The model has been successfully submitted.
          headers:
            Location:
              description: Contains a url at which the job processing the model can
                be retrieved
              schema:
                format: url
                type: string
        '422':
          description: Unable to process the request.
      summary: Run Cross Validation on a model.
      tags:
      - models
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/models/{modelId}/crossValidationScores/:
    get:
      description: "\n        Get Cross Validation scores for each partition in a\
        \ model.\n        .. note:: Individual partition scores are only available\
        \ for newer models; older models that\n                  have cross validation\
        \ score calculated will need to be retrained.\n        "
      operationId: projectsModelsCrossValidationScores_list
      parameters:
      - description: Set to the name of a metric to only return results for that metric.
        in: query
        name: metric
        required: false
        schema:
          type: string
      - description: Set to a value such as 1.0, 2.0 to only return results for the
          specified partition.
        in: query
        name: partition
        required: false
        schema:
          minimum: 0.0
          type: number
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossValidationRetrieveResponse'
          description: The Cross Validation scores for each partition in a model.
        '404':
          description: Not found.
      summary: Get Cross Validation scores for each partition in a model.
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/:
    get:
      description: Retrieve a list of Cross Class Data Disparity insights for the
        model.
      operationId: projectsModelsDataDisparityInsights_list
      parameters:
      - description: Number of items to skip. Defaults to 0 if not provided.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of items to return, defaults to 100 if not provided.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          type: integer
      - description: Feature for which insight is computed.
        in: query
        name: feature
        required: true
        schema:
          type: string
      - description: One of the compared classes.
        in: query
        name: className1
        required: true
        schema:
          type: string
      - description: Another compared class.
        in: query
        name: className2
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataDisparityRetrieveResponse'
          description: Returns Cross Class Data Disparity results.
      summary: Get Cross Class Data Disparity results.
      tags:
      - insights
      x-versionadded: v2.25
    post:
      description: Submits a job to start Cross Class Data Disparity insight calculations.
      operationId: projectsModelsDataDisparityInsights_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataDisparityCreatePayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataDisparityCreateResponse'
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Start insight calculations.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/:
    get:
      description: List of Confusion Charts objects on external datasets for a project
        with filtering option by dataset. Prediction dataset may have Confusion Chart
        for multiclass projects computed if it contained a target with actual values
        and insights were computed on this dataset. A confusion chart consists of
        the confusion matrix for all classes, classes frequencies and oneVsAll metrics
        for all classes. The confusion matrix can be requested in a particular sort
        order and orientated by rows or columns. Available for multiclass projects
        only.
      operationId: projectsModelsDatasetConfusionCharts_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Ordering the chart data by following attributes.Prefix the attribute
          name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
        in: query
        name: orderBy
        required: false
        schema:
          default: className
          enum:
          - className
          - -className
          - actualCount
          - -actualCount
          - predictedCount
          - -predictedCount
          - f1
          - -f1
          - precision
          - -precision
          - recall
          - -recall
          type: string
      - description: Determines whether the values in the rows of the confusion matrix
          should correspond to the same actual class ('actual') or predicted class
          ('predicted').
        in: query
        name: orientation
        required: false
        schema:
          default: actual
          enum:
          - actual
          - -actual
          - predicted
          - -predicted
          type: string
      - description: start index of row for slicing the confusion matrix.
        in: query
        name: rowStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: end index of row for slicing the confusion matrix.
        in: query
        name: rowEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: start index of column for slicing the confusion matrix.
        in: query
        name: colStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: end index of column for slicing the confusion matrix.
        in: query
        name: colEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The datasetId to retrieve a Confusion chart from.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The project to retrieve a Confusion chart from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model to retrieve a Confusion chart from.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfusionChartForDatasetsListResponse'
          description: List of Confusion Charts objects for external datasets.
        '404':
          description: No insights found.
      summary: List of Confusion Charts objects on external datasets for a project
        with filtering option by dataset.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/:
    get:
      description: Retrieve Confusion Chart objects on external datasets for a project.
        Prediction dataset may have Confusion Chart for multiclass projects computed
        if it contained a target with actual values and insights were computed on
        this dataset. A confusion chart consists of the confusion matrix for all classes,
        classes frequencies and oneVsAll metrics for all classes. The confusion matrix
        can be requested in a particular sort order and oriented by rows or columns
        (zero-indexed). Available for multiclass projects only.
      operationId: projectsModelsDatasetConfusionCharts_retrieve
      parameters:
      - description: Ordering the chart data by following attributes.Prefix the attribute
          name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
        in: query
        name: orderBy
        required: false
        schema:
          default: className
          enum:
          - className
          - -className
          - actualCount
          - -actualCount
          - predictedCount
          - -predictedCount
          - f1
          - -f1
          - precision
          - -precision
          - recall
          - -recall
          type: string
      - description: Determines whether the values in the rows of the confusion matrix
          should correspond to the same actual class ('actual') or predicted class
          ('predicted').
        in: query
        name: orientation
        required: false
        schema:
          default: actual
          enum:
          - actual
          - -actual
          - predicted
          - -predicted
          type: string
      - description: start index of row for slicing the confusion matrix.
        in: query
        name: rowStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: end index of row for slicing the confusion matrix.
        in: query
        name: rowEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: start index of column for slicing the confusion matrix.
        in: query
        name: colStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: end index of column for slicing the confusion matrix.
        in: query
        name: colEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The project to retrieve a Confusion chart from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model to retrieve a Confusion chart from.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset to retrieve a Confusion chart from.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfusionChartRetrieveForDatasets'
          description: Retrieve Confusion Chart objects on external datasets.
        '404':
          description: No insights found.
      summary: Retrieve Confusion Chart objects on external datasets for a project.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/classDetails/:
    get:
      description: Calculate and sends frequency of class in distributed among other
        classes for actual and predicted data. A confusion chart class details for
        given class gives stats of misclassification done by model for given class
        for actual and predicted data. Available for multiclass projects only.
      operationId: projectsModelsDatasetConfusionChartsClassDetails_list
      parameters:
      - description: Name of a class for which distribution frequency is requested.
        in: query
        name: className
        required: true
        schema:
          type: string
      - description: The project to retrieve a Confusion chart from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model to retrieve a Confusion chart from.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset to retrieve a Confusion chart from.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelConfusionChartClassDetailsForDatasetRetrieve'
          description: A confusion chart class details for given class.
        '404':
          description: No insights found.
      summary: Calculate and sends frequency of class in distributed among other classes
        for actual and predicted data.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/metadata/:
    get:
      description: Retrieve metadata for the confusion chart of a model on external
        dataset for a project. Available for multiclass projects only.
      operationId: projectsModelsDatasetConfusionChartsMetadata_list
      parameters:
      - description: Ordering the chart data by following attributes.Prefix the attribute
          name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
        in: query
        name: orderBy
        required: false
        schema:
          default: className
          enum:
          - className
          - -className
          - actualCount
          - -actualCount
          - predictedCount
          - -predictedCount
          - f1
          - -f1
          - precision
          - -precision
          - recall
          - -recall
          type: string
      - description: Determines whether the values in the rows of the confusion matrix
          should correspond to the same actual class ('actual') or predicted class
          ('predicted').
        in: query
        name: orientation
        required: false
        schema:
          default: actual
          enum:
          - actual
          - -actual
          - predicted
          - -predicted
          type: string
      - description: Number of classes in a single 'thumbnail' cell.
        in: query
        name: thumbnailCellSize
        required: false
        schema:
          default: 10
          exclusiveMinimum: true
          minimum: 1
          type: integer
      - description: The project to retrieve a Confusion chart from.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model to retrieve a Confusion chart from.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset to retrieve a Confusion chart from.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfusionChartRetrieveMetadataForDatasets'
          description: Retrieve metadata for the Confusion Chart objects on external
            datasets.
        '404':
          description: No insights found.
      summary: Retrieve metadata for the confusion chart of a model on external dataset
        for a project.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetLiftCharts/:
    get:
      description: List of Lift chart objects on prediction datasets for a project
        with filtering option by dataset. Prediction dataset may have Lift chart computed
        if it contained a column with actual values and predictions were computed
        on this dataset. This controller is not supported for multiclass classification
        projects. For multiclass, instead use /projects/<projectId>/models/<modelId>/datasetMulticlassLiftCharts/.
      operationId: projectsModelsDatasetLiftCharts_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: If provided will return Lift chart for dataset with matching
          datasetId.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiftChartForDatasetsList'
          description: Retrieve List of Lift chart data on prediction datasets.
        '404':
          description: No insights found.
      summary: Retrieve List of Lift chart data on prediction datasets for a project.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetMulticlassLiftCharts/:
    get:
      description: List of Multiclass Lift chart objects on prediction datasets for
        a project with filtering option by dataset. Prediction dataset may have Multiclass
        Lift chart computed if it contained a column with actual values and predictions
        were computed on this dataset. Multiclass Lift charts are supported for multiclass
        classification projects only.
      operationId: projectsModelsDatasetMulticlassLiftCharts_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: If provided will return Lift chart for dataset with matching
          datasetId.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticlassLiftChartForDatasetsList'
          description: Retrieve List of Multiclass Lift chart data on prediction datasets.
        '404':
          description: No insights found.
      summary: Retrieve List of Multiclass Lift chart data on prediction datasets
        for a project.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetResidualsCharts/:
    get:
      description: 'List of residuals charts objects on prediction datasets for a
        project with filtering option by dataset. Prediction dataset may have residuals
        chart computed if it contained a column with actual values and predictions
        were computed on this dataset.

        Residuals charts are supported for regression projects only.'
      operationId: projectsModelsDatasetResidualsCharts_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: If provided will return ROC curve for dataset with matching `datasetId`.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResidualsChartForDatasetsList'
          description: ''
      summary: List of residuals charts objects on prediction datasets.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/datasetRocCurves/:
    get:
      description: 'List of ROC curve objects on prediction datasets for a project
        with filtering option by dataset.


        Prediction dataset may have ROC curve computed if it contained a column with
        actual values and predictions were computed on this dataset.

        Each ROC curve object includes an array of points showing the performance
        of the model at different thresholds for classification, and arrays of sample
        predictions for both the positive and negative classes.'
      operationId: projectsModelsDatasetRocCurves_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: If provided will return ROC curve for dataset with matching `datasetId`.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RocCurveForDatasetsList'
          description: Objects were returned successfully. No objects is a valid case.
      summary: List of ROC curve objects on prediction datasets for a project with
        filtering option by dataset.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/:
    get:
      description: Retrieve a list of Per Class Bias insights for the model.
      operationId: projectsModelsFairnessInsights_list
      parameters:
      - description: Number of items to skip. Defaults to 0 if not provided.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of items to return, defaults to 100 if not provided.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          type: integer
      - description: Metric to use for calculating fairness. Can be one of ``proportionalParity``,
          ``equalParity``, ``predictionBalance``, ``trueFavorableAndUnfavorableRateParity``
          or ``FavorableAndUnfavorablePredictiveValueParity``. Used and required only
          if *Bias & Fairness in AutoML* feature is enabled.
        in: query
        name: fairnessMetricsSet
        required: false
        schema:
          enum:
          - proportionalParity
          - equalParity
          - predictionBalance
          - trueFavorableAndUnfavorableRateParity
          - favorableAndUnfavorablePredictiveValueParity
          type: string
        x-versionadded: v2.24
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FairnessInsightsListResponse'
          description: Returns Per Class Bias results.
      summary: List calculated Per Class Bias insights.
      tags:
      - insights
      x-versionadded: v2.25
    post:
      description: Submits a job to start Per Class Bias insight calculations for
        the model.
      operationId: projectsModelsFairnessInsights_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FairnessInsightsStartCalculationPayload'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FairnessInsightsStartCalculationResponse'
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Start insight calculations.
      tags:
      - insights
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/models/{modelId}/featureEffects/:
    get:
      description: 'Retrieve Feature Effects for the model.

        Feature Effects provides partial dependence and predicted vs actual values
        for the top 500 features, ordered by feature impact score.

        The partial dependence shows marginal effect of a feature on the target variable
        after accounting for the average effects of all other predictive features.
        It indicates how, holding all other variables except the feature of interest
        as they were, the value of this feature affects your prediction.

        If a Feature Effects job was previously submitted, this endpoint will return
        a response structured as {"message": <message>, "jobId": <jobId>} where jobId
        is the ID of the job. Retrieve the job with :http:get:`/api/v2/projects/(projectId)/jobs/(jobId)/`'
      operationId: projectsModelsFeatureEffects_list
      parameters:
      - description: Models data source.
        in: query
        name: source
        required: false
        schema:
          default: training
          enum:
          - training
          - validation
          - holdout
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureEffectsResponse'
          description: ''
        '403':
          description: User does not have permission to view the project.
        '404':
          description: Project, model, source or computation results do not exist.
      summary: Retrieve Feature Effects for the model.
      tags:
      - insights
      x-versionadded: v2.18
    post:
      description: 'Add a request to the queue to calculate Feature Effects.

        If the job has been previously submitted, the request fails, returning the
        `jobId` of the previously submitted job. Use this `jobId` to check status
        of the previously submitted job.'
      operationId: projectsModelsFeatureEffects_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureEffectCreate'
      responses:
        '202':
          description: The Feature Effects request has been successfully submitted.
            See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have permission to view or submit jobs for the
            project.
        '404':
          description: Provided project or model does not exist.
        '422':
          description: "Queue submission error.\n\n.. minversion:: v2.21\n\n    If\
            \ the rowCount exceeds the maximum or minimum value for this dataset.\
            \ Minimum\n    is 10 rows. Maximum is 100000 rows or the training sample\
            \ size of the model,\n    whichever is less.\n"
      summary: Add a request to the queue to calculate Feature Effects.
      tags:
      - insights
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/models/{modelId}/featureEffectsMetadata/:
    get:
      description: 'Retrieve Feature Effects metadata. Response contains status and
        available sources.

        One of the provided `source` parameters used for retrieving Feature Effects.

        * Source can be, at a minimum, `training` or `validation`. If holdout is configured
        for the project, `source` also includes `holdout`.

        * Source value of `training` is always available. (versions prior to v2.17
        support `validation` only)

        * When a model is trained into `validation` or `holdout` without stacked predictions
        (i.e., no out-of-sample predictions in `validation` or `holdout`), `validation`
        and `holdout` sources are not available.'
      operationId: projectsModelsFeatureEffectsMetadata_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelXrayMetadataResponse'
          description: ''
        '403':
          description: User does not have permission to view the project.
        '404':
          description: Project or model does not exist.
        '422':
          description: The model is datetime partitioned.
      summary: Retrieve Feature Effects metadata. Response contains status and available
        sources.
      tags:
      - insights
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/models/{modelId}/featureImpact/:
    get:
      description: 'Retrieve feature impact scores for features in a model.

        Feature Impact is computed for each column by creating new data with that
        column randomly permuted (but the others left unchanged), and seeing how the
        error metric score for the predictions is affected. Elsewhere this technique
        is sometimes called ''Permutation Importance''.

        The `impactUnnormalized` is how much worse the error metric score is when
        making predictions on this modified data. The `impactNormalized` is normalized
        so that the largest value is 1. In both cases, larger values indicate more
        important features. If a feature is a redundant feature, i.e. once other features
        are considered it doesn''t contribute much in addition, the `redundantWith`
        value is the name of feature that has the highest correlation with this feature.'
      operationId: projectsModelsFeatureImpact_list
      parameters:
      - description: The backtest value used for Feature Impact computation. Applicable
          for datetime aware models.
        in: query
        name: backtest
        required: false
        schema:
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
        x-versionadded: v2.28
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermutationFeatureImpactResponse'
          description: ''
        '404':
          description: No feature impact data found for the given model.
      summary: Retrieve feature impact scores for features in a model.
      tags:
      - insights
      x-versionadded: v2.3
    post:
      description: 'Add a request to calculate feature impact to the queue.

        If the job has been previously submitted, the request  will fail and return
        the `jobId` of previously submitted job. This `jobId` can be used to check
        status of previously submitted job.'
      operationId: projectsModelsFeatureImpact_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermutationFeatureImpactCreatePayload'
      responses:
        '202':
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '404':
          description: If `modelId` does not exist in project leaderboard
        '422':
          description: 'If feature impact has already run will return error including
            `jobId` property which is the `jobId` of the previously started feature
            impact job.


            .. minversion:: v2.21


            If the `rowCount` exceeds the maximum or minimum value for this dataset.
            Minimum is 10 rows. Maximum is 100000 rows or the training sample size
            of the model, whichever is less.

            '
      summary: Add a request to calculate feature impact to the queue.
      tags:
      - insights
      x-versionadded: v2.3
  /api/v2/projects/{projectId}/models/{modelId}/featureLists/{datasetId}/clusterInsights/:
    get:
      description: Retrieve computed Cluster Insights for a clustering project model
        on a single featurelist.
      operationId: projectsModelsFeatureListsClusterInsights_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 15
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Order results by the specified field value.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - featureImpact
          - -featureImpact
          - featureName
          - -featureName
          type: string
      - description: Search for a specific string in a feature name.This search is
          case insensitive. If not specified, all features will be returned.
        in: query
        name: searchFor
        required: false
        schema:
          maxLength: 100
          minLength: 1
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset ID
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterInsightsPaginatedResponse'
          description: Insights for a clustering project model on a single featurelist.
        '404':
          description: The project or the model was not found or insights have not
            been computed yet.
        '422':
          description: Feature Impact is required. Please, compute it first.
      summary: Retrieve Cluster Insights for a single featurelist
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/features/:
    get:
      description: List the features used in a model
      operationId: projectsModelsFeatures_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelFeatureListResponse'
          description: The features used in a model.
        '404':
          description: This resource does not exist.
      summary: List the features used in a model.
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/models/{modelId}/imageActivationMaps/:
    get:
      description: 'Retrieve Image Activation Maps for a feature of a model.

        Image Activation maps are a technique to get the discriminative image regions
        used by a CNN to identify a specific class in the image. In other words, an
        image activation map lets us see which regions in the image were relevant
        to this class.  The higher the value in the activation map the greater the
        effect the region had on the prediction.'
      operationId: projectsModelsImageActivationMaps_list
      parameters:
      - description: Name of the feature to query
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivationMapsRetrieveResponse'
          description: Image Activation Maps
        '422':
          description: Unable to process request.
      summary: Retrieve Image Activation Maps for a feature of a model.
      tags:
      - insights
      - images
      x-versionadded: v2.21
    post:
      description: Request the computation of image activation maps for the specified
        model.
      operationId: projectsModelsImageActivationMaps_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivationMapsComputeResponse'
          description: Image activation map computation has been successfully requested
          headers:
            Location:
              description: a url that can be polled to check the status of the job.
              schema:
                format: url
                type: string
        '422':
          description: 'Cannot compute image activation maps: if image activation
            maps were already computed for the model or there was another issue creating
            this job'
      summary: Request the computation of image activation maps for the specified
        model.
      tags:
      - insights
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/:
    get:
      description: Retrieve ImageEmbeddings for a feature of a model.
      operationId: projectsModelsImageEmbeddings_list
      parameters:
      - description: Name of the feature to query
        in: query
        name: featureName
        required: true
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingsRetrieveResponse'
          description: Image Embeddings
        '422':
          description: Unable to process request.
      summary: Retrieve ImageEmbeddings for a feature of a model.
      tags:
      - insights
      - images
      x-versionadded: v2.21
    post:
      description: Request the computation of image embeddings for the specified model.
      operationId: projectsModelsImageEmbeddings_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageEmbeddingsComputeResponse'
          description: Image embedding computation has been successfully requested
          headers:
            Location:
              description: a url that can be polled to check the status of the job.
              schema:
                format: url
                type: string
        '422':
          description: 'Cannot compute image embeddings: if image embeddings were
            already computed for the model or there was another issue creating this
            job'
      summary: Request the computation of image embeddings for the specified model.
      tags:
      - insights
      - images
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/labelwiseRocCurves/{source}/:
    get:
      description: Retrieve labelwise ROC curves for model and given source.
      operationId: projectsModelsLabelwiseRocCurves_list
      parameters:
      - description: Labels for which data is requested.
        in: query
        name: labels
        required: false
        schema:
          type: string
      - description: Search query for label.
        in: query
        name: searchQuery
        required: false
        schema:
          type: string
      - description: Property to sort labels in the response.
        in: query
        name: sortBy
        required: false
        schema:
          default: label
          enum:
          - accuracy
          - f1Score
          - falsePositiveRate
          - label
          - matthewsCorrelationCoefficient
          - negativePredictiveValue
          - positivePredictiveValue
          - trueNegativeRate
          - truePositiveRate
          type: string
      - description: Sort order.
        in: query
        name: sortOrder
        required: false
        schema:
          default: ascending
          enum:
          - ascending
          - descending
          type: string
      - description: Threshold at which the metric should be sorted.
        in: query
        name: threshold
        required: false
        schema:
          maximum: 1.0
          minimum: 0.0
          type: number
      - description: Number of labels to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of labels to return.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Whether model average metrics should be included in the response.
        in: query
        name: includeModelAverage
        required: false
        schema:
          default: false
          type: boolean
      - description: Project Id.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Model Id.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Chart source.
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelwiseROC'
          description: Labelwise ROC curves for model and given source.
      summary: Retrieve labelwise ROC curves for model and given source.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/liftChart/:
    get:
      description: Retrieve all available lift charts for model. The response will
        include a json list of all available lift charts, in the same format as the
        response from :http:get:`/api/v2/projects/(projectId)/models/(modelId)/liftChart/(source)/`.
      operationId: projectsModelsLiftChart_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelLiftChartListResponse'
          description: A list of all of the available lift charts for a model.
        '403':
          description: Invalid Permissions
        '404':
          description: Please use multiclass lift route for per-class lift data.
        '422':
          description: Lift chart is not available for unsupervised mode projects.
      summary: Retrieve all available lift charts for model.
      tags:
      - insights
      x-versionadded: v2.7
  /api/v2/projects/{projectId}/models/{modelId}/liftChart/{source}/:
    get:
      description: Retrieve the lift chart data from a single source.
      operationId: projectsModelsLiftChart_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
        x-enum-versionadded:
        - value: backtest_2
          x-versionadded: v2.23
        - value: backtest_3
          x-versionadded: v2.23
        - value: backtest_4
          x-versionadded: v2.23
        - value: backtest_5
          x-versionadded: v2.23
        - value: backtest_6
          x-versionadded: v2.23
        - value: backtest_7
          x-versionadded: v2.23
        - value: backtest_8
          x-versionadded: v2.23
        - value: backtest_9
          x-versionadded: v2.23
        - value: backtest_10
          x-versionadded: v2.23
        - value: backtest_11
          x-versionadded: v2.23
        - value: backtest_12
          x-versionadded: v2.23
        - value: backtest_13
          x-versionadded: v2.23
        - value: backtest_14
          x-versionadded: v2.23
        - value: backtest_15
          x-versionadded: v2.23
        - value: backtest_16
          x-versionadded: v2.23
        - value: backtest_17
          x-versionadded: v2.23
        - value: backtest_18
          x-versionadded: v2.23
        - value: backtest_19
          x-versionadded: v2.23
        - value: backtest_20
          x-versionadded: v2.23
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelLiftChartResponse'
          description: Lift chart data from a single source.
      summary: Retrieve the lift chart data from a single source.
      tags:
      - insights
      x-versionadded: v2.7
  /api/v2/projects/{projectId}/models/{modelId}/logs/:
    get:
      description: Retrieve an archive (tar.gz) of the logs produced and persisted
        by a model. Note that only blueprints with custom tasks create persistent
        logs - this will not work with any other type of model.
      operationId: projectsModelsLogs_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentLogsForModelWithCustomTasksRetrieveResponse'
          description: An archive (tar.gz) of the logs produced and persisted by a
            model.
        '403':
          description: User does not have permissions to fetch model logs.
        '404':
          description: Logs for this model could not be found.
      summary: Retrieve an archive (tar.gz) of the logs produced and persisted by
        a model.
      tags:
      - models
      - custom_tasks
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/missingReport/:
    get:
      description: "Retrieve a summary of how the model's subtasks handle missing\
        \ values\n        Only models built after the missing value report feature\
        \ was added will have reports,\n        and only models with at least one\
        \ imputation or encoding task, e.g. ordinal encoding,\n        missing value\
        \ imputation. Blenders and scaleout models do not support Missing Value reports.\n\
        \n        The report will describe how each feature's missing values were\
        \ treated, and report how many\n        missing values were present in the\
        \ training data. Features which were not processed by a\n        given blueprint\
        \ task will not mention it: for instance, a categorical feature with many\n\
        \        unique values may not be considered eligible for processing by a\
        \ One-Hot Encoding\n\n        Report is collected for those features which\
        \ are considered eligible by given\n        blueprint task. For instance,\
        \ categorical feature with a lot of unique values may not be\n        considered\
        \ as eligible in One-Hot Encoding Task."
      operationId: projectsModelsMissingReport_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MissingReportRetrieve'
          description: Retrieve a summary of how the model's subtasks handle missing
            values.
        '404':
          description: 'Could not found missing value report for provided project
            & model id. '
      summary: Retrieve a summary of how the model's subtasks handle missing values.
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/:
    get:
      description: Retrieve feature effects for each class in a multiclass model.
      operationId: projectsModelsMulticlassFeatureEffects_list
      parameters:
      - description: Models data source.
        in: query
        name: source
        required: false
        schema:
          default: training
          enum:
          - training
          - validation
          - holdout
          type: string
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: Target class label.
        in: query
        name: class
        required: false
        schema:
          nullable: true
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticlassFeatureEffectsResponse'
          description: ''
        '403':
          description: User does not have permission to view the project.
        '404':
          description: Project, model, source or computation results do not exist.
      summary: Retrieve feature effects for each class in a multiclass model.
      tags:
      - insights
      x-versionadded: v2.27
    post:
      description: 'Compute feature effects for a multiclass model. If the job has
        been previously submitted, the request fails, returning the `jobId` of the
        previously submitted job. Use this `jobId` to check status of the previously
        submitted job.

        NOTE: feature effects are computed for top 100 classes.'
      operationId: projectsModelsMulticlassFeatureEffects_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MulticlassFeatureEffectCreate'
      responses:
        '202':
          description: The Feature Effects request has been successfully submitted.
            See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '403':
          description: User does not have permission to view or submit jobs for the
            project.
        '404':
          description: Project, model, source or computation results do not exist.
        '422':
          description: Queue submission error. If the rowCount exceeds the maximum
            or minimum value for this dataset. Minimum is 10 rows. Maximum is 100000
            rows or the training sample size of the model, whichever is less. If neither
            ``features`` nor ``topNFeatures`` is provided.
      summary: Compute feature effects for a multiclass model.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureImpact/:
    get:
      description: 'Retrieve feature impact scores for each class in a multiclass
        model.

        Feature Impact is computed for each column by creating new data with that
        column randomly permuted (but the others left unchanged), and seeing how the
        error metric score for the predictions is affected. Elsewhere this technique
        is sometimes called ''Permutation Importance''.

        The `impactUnnormalized` is how much worse the error metric score is when
        making predictions on this modified data. The `impactNormalized` is normalized
        so that the largest value is 1. In both cases, larger values indicate more
        important features.'
      operationId: projectsModelsMulticlassFeatureImpact_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticlassFeatureImpactResponse'
          description: ''
        '404':
          description: If no feature impact data found for a given model.
      summary: Retrieve feature impact scores for each class in a multiclass model.
      tags:
      - insights
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/:
    get:
      description: Retrieve all available lift charts for multiclass model.
      operationId: projectsModelsMulticlassLiftChart_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllMulticlassModelLiftChartsResponse'
          description: Multiclass lift chart data.
      summary: Retrieve all available lift charts for multiclass model.
      tags:
      - insights
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/{source}/:
    get:
      description: Retrieve the multiclass lift chart data from a single source.
      operationId: projectsModelsMulticlassLiftChart_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data.
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticlassModelLiftChartResponse'
          description: Multiclass lift chart data from a single source.
      summary: Retrieve the multiclass lift chart data from a single source.
      tags:
      - insights
      x-versionadded: v2.20
  /api/v2/projects/{projectId}/models/{modelId}/multilabelLiftCharts/{source}/:
    get:
      description: Retrieve labelwise lift charts for model and given source.
      operationId: projectsModelsMultilabelLiftCharts_retrieve
      parameters:
      - description: Labels for which data is requested.
        in: query
        name: labels
        required: false
        schema:
          type: string
      - description: Project Id.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Model Id.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Chart source.
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelwiseLiftChart'
          description: Labelwise lift charts for model and given source.
      summary: Retrieve labelwise lift charts for model and given source.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/models/{modelId}/numIterationsTrained/:
    get:
      description: Retrieve the actual number of iterations or estimators trained
        by a tree-based early stopping model.
      operationId: projectsModelsNumIterationsTrained_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumIterationsTrainedResponse'
          description: The number of estimators/iterations trained
        '404':
          description: Cannot retrieve early stopping information for this model.
      summary: Get number of iterations trained
      tags:
      - models
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/models/{modelId}/parameters/:
    get:
      description: Retrieve model parameters. These are the parameters that appear
        in the webapp on the `Coefficients` tab. Note that they are only available
        for some models.
      operationId: projectsModelsParameters_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelParametersRetrieveResponse'
          description: The parameters of the model.
        '422':
          description: Unable to process the request.
      summary: Retrieve model parameters.
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/:
    delete:
      description: Delete an existing PredictionExplanationsInitialization.
      operationId: projectsModelsPredictionExplanationsInitialization_deleteMany
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The deletion was successful.
      summary: Delete an existing PredictionExplanationsInitialization.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
    get:
      description: 'Retrieve the current PredictionExplanationsInitialization.

        A PredictionExplanationsInitialization is a pre-requisite for successfully
        computing prediction explanations using a particular model, and can be used
        to preview the prediction explanations that would be generated for a complete
        dataset.'
      operationId: projectsModelsPredictionExplanationsInitialization_list
      parameters:
      - description: Whether to include adjusted prediction in the PredictionExplanationsSample
          response.
        in: query
        name: excludeAdjustedPredictions
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionExplanationsInitializationRetrieve'
      responses:
        '200':
          description: ''
      summary: Retrieve the current PredictionExplanationsInitialization.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
    post:
      description: Create a new prediction explanations initialization. This is a
        necessary prerequisite for generating prediction explanations.
      operationId: projectsModelsPredictionExplanationsInitialization_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionExplanationsInitializationCreate'
      responses:
        '202':
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create a new prediction explanations initialization.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/models/{modelId}/predictionIntervals/:
    get:
      description: 'Retrieve prediction intervals (in descending order) that are already
        calculated for this model.

        Note that the project this model belongs to must be a time series project.'
      operationId: projectsModelsPredictionIntervals_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: The project to retrieve prediction intervals for. Must be a time
          series project.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model to retrieve prediction intervals for.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionIntervalsListResponse'
          description: Request was successful.
      summary: Retrieve prediction intervals that are already calculated for this
        model.
      tags:
      - models
      x-versionadded: v2.19
    post:
      description: "Submit a job to calculate prediction intervals for the specified\
        \ percentiles for this model. \nNote that the project this model belongs to\
        \ must be a time series project."
      operationId: projectsModelsPredictionIntervals_create
      parameters:
      - description: The project to calculate prediction intervals for. Must be a
          time series project.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model to calculate prediction intervals for.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionIntervalsCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionIntervalsCreateResponse'
          description: Job was successfully submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Calculate prediction intervals for the specified percentiles for this
        model.
      tags:
      - models
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/models/{modelId}/primeInfo/:
    get:
      description: Check if a model can be approximated by DataRobot Prime
      operationId: projectsModelsPrimeInfo_list
      parameters:
      - description: the project the model belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the model to check
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrimeInfoRetrieveResponse'
          description: ''
      summary: Check a Model for Prime Eligibility
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/models/{modelId}/primeRulesets/:
    get:
      description: 'List all the rulesets approximating a model


        When rulesets are created for the parent model, all of the rulesets are created
        at once, but not all rulesets have corresponding Prime models (until they
        are directly requested).'
      operationId: projectsModelsPrimeRulesets_list
      parameters:
      - description: the project the model belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the model to find approximating rulesets for
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PrimeRulesetsListResponse'
                type: array
          description: ''
      summary: List Rulesets
      tags:
      - models
      x-versionadded: v2.4
    post:
      description: Approximate an existing model on the leaderboard with DataRobot
        Prime. A request body should be an empty JSON {}
      operationId: projectsModelsPrimeRulesets_create
      parameters:
      - description: the project the model to approximate belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the model to approximate
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrimeRulesetsCreatePayload'
      responses:
        '202':
          description: The request was understood and accepted, and is now being worked
            on. See the Location header
          headers:
            Location:
              description: a url that can be polled to check the status of the job
              schema:
                format: url
                type: string
      summary: Create Rulesets
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/models/{modelId}/residuals/:
    get:
      description: Retrieve all residuals charts for a model.
      operationId: projectsModelsResiduals_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelResidualsList'
          description: ''
      summary: Retrieve all residuals charts for a model.
      tags:
      - insights
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/models/{modelId}/residuals/{source}/:
    get:
      description: Retrieve the residuals chart data from a single source.
      operationId: projectsModelsResiduals_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data.
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelResidualsList'
          description: ''
      summary: Retrieve the residuals chart data from a single source.
      tags:
      - insights
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/models/{modelId}/rocCurve/:
    get:
      description: Retrieve all available ROC curves for model. The response will
        include a json list of all available ROC curves, in the same format as the
        response from :http:get:`/api/v2/projects/(projectId)/models/(modelId)/rocCurve/(source)/`.
      operationId: projectsModelsRocCurve_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRocCurveListResponse'
          description: A list of all of the available ROC curves for a model.
        '403':
          description: Invalid Permissions
        '404':
          description: This resource does not exist.
        '422':
          description: Unsupervised mode projects do not have ROC curves
      summary: Retrieve all available ROC curves for model.
      tags:
      - insights
      x-versionadded: v2.7
  /api/v2/projects/{projectId}/models/{modelId}/rocCurve/{source}/:
    get:
      description: Retrieve the ROC curve data from a single source. The response
        includes an array of pointsshowing the performance of the model at different
        thresholds for classification, and arrays of sample predictions for both the
        positive and negative classes.
      operationId: projectsModelsRocCurve_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: Source of the data
        in: path
        name: source
        required: true
        schema:
          enum:
          - validation
          - crossValidation
          - holdout
          - backtest_2
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_20
          type: string
        x-enum-versionadded:
        - value: backtest_2
          x-versionadded: v2.23
        - value: backtest_3
          x-versionadded: v2.23
        - value: backtest_4
          x-versionadded: v2.23
        - value: backtest_5
          x-versionadded: v2.23
        - value: backtest_6
          x-versionadded: v2.23
        - value: backtest_7
          x-versionadded: v2.23
        - value: backtest_8
          x-versionadded: v2.23
        - value: backtest_9
          x-versionadded: v2.23
        - value: backtest_10
          x-versionadded: v2.23
        - value: backtest_11
          x-versionadded: v2.23
        - value: backtest_12
          x-versionadded: v2.23
        - value: backtest_13
          x-versionadded: v2.23
        - value: backtest_14
          x-versionadded: v2.23
        - value: backtest_15
          x-versionadded: v2.23
        - value: backtest_16
          x-versionadded: v2.23
        - value: backtest_17
          x-versionadded: v2.23
        - value: backtest_18
          x-versionadded: v2.23
        - value: backtest_19
          x-versionadded: v2.23
        - value: backtest_20
          x-versionadded: v2.23
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRocCurveResponse'
          description: ROC curve data from a single source.
      summary: Retrieve the ROC curve data from a single source.
      tags:
      - insights
      x-versionadded: v2.7
  /api/v2/projects/{projectId}/models/{modelId}/scoringCode/:
    get:
      description: 'Retrieve Scoring Code for making new predictions from an existing
        model offline.

        You need the "Scoring Code" feature enabled to use this route.


        By default, returns a compiled executable JAR that can be executed locally
        to calculate model predictions, or it can be used as a library for a Java
        application. Execute it with the ''--help` parameters to learn how to use
        it as a command-line utility.

        See model API documentation (https://javadoc.io/doc/com.datarobot/datarobot-prediction/latest/index.html)
        to be able to use it inside an existing Java application.


        With the sourceCode query parameter set to ''true'', returns a source code
        archive that can be used to review internal calculations of the model. This
        JAR is NOT executable.


        See "https://docs.datarobot.com/en/docs/predictions/port-pred/scoring-code/index.html"
        in DataRobot application for more information.'
      operationId: projectsModelsScoringCode_list
      parameters:
      - description: If set to "true", the downloaded JAR file will contain only the
          source code and will not be executable.
        in: query
        name: sourceCode
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: the project that created the model
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the model to use
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: JAR file
          headers:
            Content-Disposition:
              description: attachment; filename="<"filename">".jar The suggested filename
                for the scoring code is dynamically generated
              schema:
                type: string
            Content-Type:
              description: application/java-archive
              schema:
                type: string
      summary: Retrieve Scoring Code
      tags:
      - models
      x-versionadded: v2.7
  /api/v2/projects/{projectId}/models/{modelId}/shapImpact/:
    get:
      description: Retrieve Feature Impact for a model. Shap impact is computed by
        calculating the shap values on a sample of training data and then taking the
        mean absolute value for each column. The larger value of impact indicate more
        important feature.
      operationId: projectsModelsShapImpact_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShapImpactRetrieveResponse'
          description: Retrieve Feature Impact for a model.
        '400':
          description: Request for multiclass project
        '404':
          description: No Shapley-based impact values calculated for this model
      summary: Retrieve Feature Impact for a model.
      tags:
      - insights
      x-versionadded: v2.21
    post:
      description: Create a Shap based Feature Impact with a model.
      operationId: projectsModelsShapImpact_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureImpactCreatePayload'
      responses:
        '202':
          description: ''
      summary: Create a Shap based Feature Impact.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/supportedCapabilities/:
    get:
      description: Get supported capabilities for a model.
      operationId: projectsModelsSupportedCapabilities_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelCapabilitiesRetrieveResponse'
          description: Successfully returned model capability information.
        '404':
          description: Resource not found.
      summary: Get supported capabilities for a model.
      tags:
      - models
      x-versionadded: v2.14
  /api/v2/projects/{projectId}/models/{modelId}/trainingArtifact/:
    get:
      description: Retrieve an archive (tar.gz) of the artifacts produced and persisted
        by a model. Note that only blueprints with custom tasks create these artifacts
        - this will not work with any other type of model.
      operationId: projectsModelsTrainingArtifact_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactsForModelWithCustomTasksRetrieveResponse'
          description: An archive (tar.gz) of the artifacts produced by this model.
        '403':
          description: User does not have permissions to fetch this artifact.
        '404':
          description: The model with this modelID does not have any artifacts.
      summary: Retrieve an archive (tar.gz) of the artifacts produced and persisted
        by a model.
      tags:
      - models
      - custom_tasks
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/models/{modelId}/wordCloud/:
    get:
      description: Retrieve word cloud data for a model. Not all models will have
        word cloud data available, even when they use text features.
      operationId: projectsModelsWordCloud_list
      parameters:
      - description: Set to true if you want stopwords excluded from the response.
        in: query
        name: excludeStopWords
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WordCloudRetrieveResponse'
          description: ''
      summary: Retrieve word cloud data for a model.
      tags:
      - insights
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/multicategoricalInvalidFormat/:
    get:
      description: Retrieve multicategorical data quality log.
      operationId: projectsMulticategoricalInvalidFormat_list
      parameters:
      - description: The ID of the project this request is associated with.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MulticategoricalInvalidFormatResponse'
          description: Data quality log for multicategorical features.
        '422':
          description: Not a data quality enabled project
      summary: Retrieve multicategorical data quality log.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/multicategoricalInvalidFormat/file/:
    get:
      description: Get file with format errors of potential multicategorical features.
      operationId: projectsMulticategoricalInvalidFormatFile_list
      parameters:
      - description: The ID of the project this request is associated with.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: File with format errors of potential multicategorical features.
      summary: Get file with format errors of potential multicategorical features.
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/multiseriesIds/{multiseriesId}/crossSeriesProperties/:
    get:
      description: 'Retrieve eligible cross-series group-by columns.


        Note that validation will have to have been triggered via :http:post:`/api/v2/projects/(projectId)/crossSeriesProperties/`
        in order for results to appear here.'
      operationId: projectsMultiseriesIdsCrossSeriesProperties_list
      parameters:
      - description: The names of the columns to retrieve the validation status for.
          If not specified, all eligible columns will be returned.
        in: query
        name: crossSeriesGroupByColumns
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: The project to retrieve cross-series group-by columns for.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The name of the column to be used as the multiseries ID column.
        in: path
        name: multiseriesId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossSeriesGroupByColumnRetrieveResponse'
          description: Request was successful.
      summary: Retrieve eligible cross-series group-by columns.
      tags:
      - projects
      x-versionadded: v2.15
  /api/v2/projects/{projectId}/multiseriesNames/:
    get:
      description: List the individual series names of a multiseries project
      operationId: projectsMultiseriesNames_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiseriesNamesControllerResponse'
          description: ''
      summary: List the names of a multiseries project.
      tags:
      - projects
      x-versionadded: v2.28
  /api/v2/projects/{projectId}/multiseriesProperties/:
    post:
      description: Analyze relationships between potential partition and multiseries
        ID columns. Time series projects require that each timestamp have at most
        one row corresponding to it. However, multiple series of data can be handled
        within a single project by designating a multiseries ID column that assigns
        each row to a particular series.  See the :ref:`multiseries <multiseries>`
        docs on time series projects for more information. A detection job analyzing
        the relationship between the multiseries ID column and the datetime partition
        column must be ran before it can be used.  If the desired multiseries ID column(s)
        are known, it can be specified to limit the analysis to only those columns.
      operationId: projectsMultiseriesProperties_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiseriesPayload'
      responses:
        '202':
          description: Request to analyze relationships between potential partition
            and multiseries ID columns was submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Detect multiseries properties
      tags:
      - projects
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/optimizedDatetimePartitionings/:
    get:
      description: List all created optimized datetime partitioning configurations
      operationId: projectsOptimizedDatetimePartitionings_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 20
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptimizedDatetimePartitioningListResponse'
          description: List of optimized datetime partitionings for projectId
      summary: List all created optimized datetime partitioning configurations
      tags:
      - datetime_partitioning
      x-versionadded: v2.22
    post:
      description: 'Create an optimized datetime partitioning configuration using
        the target.


        Initializes a job to construct an optimized datetime partitioning using the
        date and target information to ensure that backtests sufficiently cover regions
        of interest in the target. This is an asynchronous job. The results of the
        asynchronous job (backtests and other parameters can be used in the synchronous
        version.


        `useTimeSeries` controls whether a time series project should be created or
        a normal project that uses datetime partitioning. See :ref:`Time-Series Projects<time_series_overview>`
        for more detail on the differences between time series projects and datetime
        partitioned projects. Time-series projects are only available to some users
        and use the additional settings of `featureDerivationWindowStart` and `featureDerivationWindowEnd`
        to establish feature derivation window and `forecastWindowStart` and `forecastWindowEnd`
        to establish a forecast window. The overview referenced above provides more
        information about using feature derivation and forecast windows.


        When specifying a feature derivation window of a forecast window, the number
        of units it spans (end - start) must be an integer multiple of the timeStep
        of the datetimePartitionColumn.


        All durations and datetimes should be specified in accordance with the :ref:`timestamp
        and duration formatting rules<time_format>`.'
      operationId: projectsOptimizedDatetimePartitionings_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptimizedDatetimePartitioningData'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimePartitioningResponse'
          description: Generated datetime partitioning.
      summary: Create an optimized datetime partitioning configuration using the target.
      tags:
      - datetime_partitioning
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/optimizedDatetimePartitionings/{datetimePartitioningId}/:
    get:
      description: 'Retrieve optimized datetime partitioning configuration


        The optimized datetime partition objects are structurally identical to the
        original datetime partition objects, however they are retrieved from a mongo
        database after creation as opposed to being calculated synchronously. The
        datetime partition object in the response describes the full partitioning
        parameters.


        The available training data corresponds to all the data available for training,
        while the primary training data corresponds to the data that can be used to
        train while ensuring that all backtests are available. If a model is trained
        with more data than is available in the primary training data, then all backtests
        may not have scores available.


        .. note:: All durations and datetimes should be specified in accordance with
        the :ref:`timestamp and duration formatting rules <time_format>`.'
      operationId: projectsOptimizedDatetimePartitionings_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the datetime partitioning to retrieve.
        in: path
        name: datetimePartitioningId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimePartitioningResponse'
          description: Optimized datetime partitioning configuration
      summary: Retrieve optimized datetime partitioning configuration
      tags:
      - datetime_partitioning
      x-versionadded: v2.22
  /api/v2/projects/{projectId}/optimizedDatetimePartitionings/{datetimePartitioningId}/datetimePartitioningInput/:
    get:
      description: 'Retrieve optimized datetime partitioning input


        The datetime partition object in the response describes the inputs used to
        create the full partitioning object.'
      operationId: projectsOptimizedDatetimePartitioningsDatetimePartitioningInput_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the datetime partitioning to retrieve.
        in: path
        name: datetimePartitioningId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptimizedDatetimePartitioningData'
          description: Optimized datetime partitioning input
      summary: Retrieve optimized datetime partitioning input
      tags:
      - datetime_partitioning
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables a simplified date/time partitioning flow, including guardrails
          for window settings and better visualizations of pending configuration.
        enabled_by_default: true
        maturity: GA_ALL
        name: SIMPLIFIED_DATETIME_PARTITIONING
      x-versionadded: v2.31
  /api/v2/projects/{projectId}/optimizedDatetimePartitionings/{datetimePartitioningId}/datetimePartitioningLog/:
    get:
      description: 'Retrieve the datetime partitioning log content and log length
        for an optimized datetime partitioning as JSON.


        The Date/Time Partitioning Log provides details about the partitioning process
        for an OTV or Time Series project.'
      operationId: projectsOptimizedDatetimePartitioningsDatetimePartitioningLog_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the datetime partitioning to retrieve.
        in: path
        name: datetimePartitioningId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatetimePartitioningLogListControllerResponse'
          description: ''
      summary: Retrieve the datetime partitioning log and log length as JSON
      tags:
      - datetime_partitioning
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables a simplified date/time partitioning flow, including guardrails
          for window settings and better visualizations of pending configuration.
        enabled_by_default: true
        maturity: GA_ALL
        name: SIMPLIFIED_DATETIME_PARTITIONING
      x-versionadded: v2.31
  /api/v2/projects/{projectId}/optimizedDatetimePartitionings/{datetimePartitioningId}/datetimePartitioningLog/file/:
    get:
      description: 'Retrieve a text file containing the datetime partitioning log.


        The Date/Time Partitioning Log provides details about the partitioning process
        for an OTV or Time Series project.'
      operationId: projectsOptimizedDatetimePartitioningsDatetimePartitioningLogFile_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the datetime partitioning to retrieve.
        in: path
        name: datetimePartitioningId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - text/plain
                type: string
      summary: Retrieve a text file containing the datetime partitioning log
      tags:
      - datetime_partitioning
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables a simplified date/time partitioning flow, including guardrails
          for window settings and better visualizations of pending configuration.
        enabled_by_default: true
        maturity: GA_ALL
        name: SIMPLIFIED_DATETIME_PARTITIONING
      x-versionadded: v2.31
  /api/v2/projects/{projectId}/payoffMatrices/:
    get:
      description: List of all payoff matrices for a project.
      operationId: projectsPayoffMatrices_list
      parameters:
      - description: Number of payoff matrices to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Number of payoff matrices to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoffMatricesListResponse'
          description: List of payoff matrices.
      summary: List of all payoff matrices for a project.
      tags:
      - insights
      x-versionadded: v2.21
    post:
      description: Create a payoff matrix associated with a project.
      operationId: projectsPayoffMatrices_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoffMatricesCreate'
      responses:
        '201':
          description: ''
        '409':
          description: 'Conflict occurred: [Error details from exception]'
        '422':
          description: "\n                - This route is only allowed for binary\
            \ classification projects.\n                - Error occurred during processing:\
            \ [Error details from exception]\n\n            "
      summary: Create a payoff matrix.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/:
    delete:
      description: Delete a payoff matrix in a project.
      operationId: projectsPayoffMatrices_delete
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: ObjectId of the payoff matrix.
        in: path
        name: payoffMatrixId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Payoff matrix deleted successfully.
      summary: Delete a payoff matrix in a project.
      tags:
      - insights
      x-versionadded: v2.21
    put:
      description: Update all fields in a payoff matrix, including values and label.
      operationId: projectsPayoffMatrices_put
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: ObjectId of the payoff matrix.
        in: path
        name: payoffMatrixId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoffMatricesCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoffMatricesResponse'
          description: Updated payoff matrix values and label.
      summary: Update a payoff matrix.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/predictJobs/:
    get:
      description: List all prediction jobs for a project
      operationId: projectsPredictJobs_list
      parameters:
      - description: If provided, only jobs with the same status will be included
          in the results; otherwise, queued and inprogress jobs (but not errored jobs)
          will be returned.
        in: query
        name: status
        required: false
        schema:
          enum:
          - queue
          - inprogress
          - error
          type: string
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PredictJobDetailsResponse'
                type: array
          description: A list of prediction jobs for a project
        '404':
          description: Job was not found
      summary: List all prediction jobs for a project
      tags:
      - predictions
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/predictJobs/{jobId}/:
    delete:
      description: Cancel a queued prediction job
      operationId: projectsPredictJobs_delete
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The job ID
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The job has been successfully cancelled
        '404':
          description: Job was not found or the job has already completed
      summary: Cancel a queued prediction job
      tags:
      - predictions
      x-versionadded: v2.0
    get:
      description: Look up a particular prediction job
      operationId: projectsPredictJobs_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The job ID
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictJobDetailsResponse'
          description: The job has been successfully retrieved and has not yet finished.
          headers:
            Location:
              description: present only when the requested job has finished - contains
                a url from which the completed predictions may be retrieved as with
                :http:get:`/api/v2/projects/(projectId)/predictions/(predictionId)/`
              schema:
                format: url
                type: string
        '303':
          description: The job has been successfully retrieved and has been completed.
            See Location header. The response json is also included.
      summary: Look up a particular prediction job
      tags:
      - predictions
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/predictionDatasets/:
    get:
      description: List predictions datasets uploaded to a project.
      operationId: projectsPredictionDatasets_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The project ID to query.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionDatasetListControllerResponse'
          description: Request to list the uploaded predictions datasets was successful.
      summary: List predictions datasets uploaded to a project.
      tags:
      - predictions
      x-versionadded: v2.3
  /api/v2/projects/{projectId}/predictionDatasets/dataSourceUploads/:
    post:
      description: Upload a dataset for predictions from a ``DataSource``.
      operationId: projectsPredictionDatasetsDataSourceUploads_create
      parameters:
      - description: The project ID to which the data source will be uploaded to.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionDataSource'
      responses:
        '202':
          description: Upload successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Upload a dataset for predictions from a ``DataSource``.
      tags:
      - predictions
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/predictionDatasets/datasetUploads/:
    post:
      description: Create a prediction dataset from a Dataset Asset referenced by
        AI Catalog item/version ID.
      operationId: projectsPredictionDatasetsDatasetUploads_create
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionFromCatalogDataset'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePredictionDatasetResponse'
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Target not set yet or cannot specify time series options with
            a non time series project.
      summary: Create prediction dataset
      tags:
      - predictions
      x-versionadded: v2.18
  /api/v2/projects/{projectId}/predictionDatasets/fileUploads/:
    post:
      description: Upload a file for predictions from an attached file.
      operationId: projectsPredictionDatasetsFileUploads_create
      parameters:
      - description: The project ID to which the data will be uploaded for prediction.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionFileUpload'
      responses:
        '202':
          description: Upload successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Upload a file for predictions from an attached file.
      tags:
      - predictions
      x-versionadded: v2.3
  /api/v2/projects/{projectId}/predictionDatasets/urlUploads/:
    post:
      description: Upload a file for predictions from a URL.
      operationId: projectsPredictionDatasetsUrlUploads_create
      parameters:
      - description: The project ID to which the data will be uploaded for prediction.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionURLUpload'
      responses:
        '202':
          description: Upload successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Upload a file for predictions from a URL.
      tags:
      - predictions
      x-versionadded: v2.3
  /api/v2/projects/{projectId}/predictionDatasets/{datasetId}/:
    delete:
      description: Delete a dataset that was uploaded for prediction.
      operationId: projectsPredictionDatasets_delete
      parameters:
      - description: The project ID that owns the data.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The dataset ID to delete.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The dataset has been successfully deleted.
        '404':
          description: No dataset with the specified `datasetId` found.
      summary: Delete a dataset that was uploaded for prediction.
      tags:
      - predictions
      x-versionadded: v2.3
    get:
      description: Get the metadata of a specific dataset. This only works for datasets
        uploaded to an existing project for prediction.
      operationId: projectsPredictionDatasets_retrieve
      parameters:
      - description: The project ID that owns the data.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The dataset ID to query for.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionDatasetRetrieveResponse'
          description: Request to retrieve the metadata of a specified dataset was
            successful.
      summary: Get the metadata of a specific dataset. This only works for datasets
        uploaded to an existing project for prediction.
      tags:
      - predictions
      x-versionadded: v2.3
  /api/v2/projects/{projectId}/predictionExplanations/:
    post:
      description: 'Create a new PredictionExplanations object (and its accompanying
        PredictionExplanationsRecord).

        In order to successfully create PredictionExplanations for a particular model
        and dataset, you must first

        - Compute feature impact for the model via :http:post:`/api/v2/projects/(projectId)/models/(modelId)/featureImpact/`

        - Compute a PredictionExplanationsInitialization for the model via :http:post:`/api/v2/projects/(projectId)/models/(modelId)/predictionExplanationsInitialization/`

        - Compute predictions for the model and dataset via :http:post:`/api/v2/projects/(projectId)/predictions/`

        `thresholdHigh` and `thresholdLow` are optional filters applied to speed up
        computation. When at least one is specified, only the selected outlier rows
        will have prediction explanations computed. Rows are considered to be outliers
        if their predicted value (in case of regression projects) or probability of
        being the positive class (in case of classification projects) isless than
        `thresholdLow` or greater than `thresholdHigh`. If neither is specified, prediction
        explanations will be computed for all rows.'
      operationId: projectsPredictionExplanations_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionExplanationsCreate'
      responses:
        '202':
          description: The request was accepted and will be worked on.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord).
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/predictionExplanations/{predictionExplanationsId}/:
    get:
      description: 'Retrieve stored Prediction Explanations.

        Each PredictionExplanationsRow retrieved corresponds to a row of the prediction
        dataset, although some rows may not have had prediction explanations computed
        depending on the thresholds selected.'
      operationId: projectsPredictionExplanations_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          and a new maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 3000
          maximum: 300000
          minimum: 1
          type: integer
      - description: Whether to include adjusted prediction in PredictionExplanationsRow
          response.
        in: query
        name: excludeAdjustedPredictions
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.8
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the PredictionExplanationsRecord to retrieve.
        in: path
        name: predictionExplanationsId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionExplanationsRetrieve'
          description: ''
      summary: Retrieve stored Prediction Explanations.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/predictionExplanationsRecords/:
    get:
      description: 'List PredictionExplanationsRecord objects for a project.

        These contain metadata about the computed prediction explanations and the
        location at which the PredictionExplanations can be retrieved.'
      operationId: projectsPredictionExplanationsRecords_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: If specified, only prediction explanations records computed for
          this model will be returned.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionExplanationsRecordList'
          description: The object was found and returned successfully.
      summary: List PredictionExplanationsRecord objects for a project.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/:
    delete:
      description: 'Delete saved Prediction Explanations.

        Deletes both the actual prediction explanations and the corresponding PredictionExplanationsRecord.'
      operationId: projectsPredictionExplanationsRecords_delete
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the PredictionExplanationsRecord to retrieve.
        in: path
        name: predictionExplanationsId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The object was deleted successfully.
      summary: Delete saved Prediction Explanations.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
    get:
      description: 'Retrieve a PredictionExplanationsRecord object.

        A PredictionExplanationsRecord contains metadata about the computed prediction
        explanations and the location at which the PredictionExplanations can be retrieved.'
      operationId: projectsPredictionExplanationsRecords_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the PredictionExplanationsRecord to retrieve.
        in: path
        name: predictionExplanationsId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionExplanationsRecord'
      responses:
        '200':
          description: The object was found and returned successfully.
      summary: Retrieve a PredictionExplanationsRecord object.
      tags:
      - predictions
      - insights
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/predictions/:
    get:
      description: "Get a list of prediction records.\n\n.. deprecated:: v2.21\n \
        \   Use :http:get:`/api/v2/projects/(projectId)/predictionsMetadata/` instead.\
        \ The only\n    difference is that parameter `datasetId` is renamed to `predictionDatasetId`\n\
        \    both in request and response.\n"
      operationId: projectsPredictions_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. To specify no limit,
          use 0. The default may change and a maximum limit may be imposed without
          notice.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          minimum: 0
          type: integer
      - description: Dataset id used to create the predictions
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: Model id
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The project of the predictions.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveListPredictionMetadataObjectsResponse'
          description: The json array of prediction metadata objects.
      summary: Get a list of prediction records.
      tags:
      - predictions
      x-versionadded: v2.13
    post:
      description: "There are two ways of making predictions.  The recommended way\
        \ is to first upload your\ndataset to the project, and then using the corresponding\
        \ datasetId, predict against\nthat dataset. To follow that pattern, send the\
        \ json request body.\n\nNote that requesting prediction intervals will automatically\
        \ trigger backtesting if\nbacktests were not already completed for this model.\n\
        \nThe legacy method which is deprecated is to send the file\ndirectly with\
        \ the predictions request.  If you need to predict against a file 10MB in\n\
        size or larger, you will be required to use the above workflow for uploaded\
        \ datasets.\nHowever, the following multipart/form-data can be used with small\
        \ files:\n\n:form file: a dataset to make predictions on\n:form modelId: the\
        \ model to use to make predictions\n\n.. note:: If using the legacy method\
        \ of uploading data to this endpoint, a new dataset\n   will be created behind\
        \ the scenes. For performance reasons, it would be much better\n   to utilize\
        \ the workflow of creating the dataset first and using the supported method\n\
        \   of making predictions of this endpoint. However, to preserve the functionality\
        \ of\n   existing workflows, the legacy method still exists.\n"
      operationId: projectsPredictions_create
      parameters:
      - description: The project to make predictions within.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Content types available for making request. `multipart/form-data`
          is the legacy deprecated method to send the small file with the prediction
          request.
        in: header
        name: Content-Type
        required: true
        schema:
          enum:
          - application/json
          - multipart/form-data
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePredictionFromDataset'
      responses:
        '202':
          description: Prediction has successfully been requested. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status of the predictions
                as with :http:get:`/api/v2/projects/(projectId)/predictJobs/(jobId)/`
              schema:
                type: string
        '422':
          description: The request cannot be processed.
      summary: Make new predictions.
      tags:
      - predictions
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/predictions/{predictionId}/:
    get:
      description: "Retrieve predictions that have previously been computed.\nTraining\
        \ predictions encoded either as JSON or CSV.\nIf CSV output was requested,\
        \ the returned CSV data will contain the following columns:\n\n* For regression\
        \ projects: `row_id` and `prediction`.\n* For binary classification projects:\
        \ `row_id`, `prediction`,\n  `class_<positive_class_label>` and `class_<negative_class_label>`.\n\
        * For multiclass projects: `row_id`, `prediction` and a\n  `class_<class_label>`\
        \ for each class.\n* For multilabel projects: `row_id` and for each class\n\
        \  `prediction_<class_label>` and `class_<class_label>`.\n* For time-series,\
        \ these additional columns will be added: `forecast_point`,\n  `forecast_distance`,\
        \ `timestamp`, and `series_id`.\n\n.. minversion:: v2.21\n\n    * If `explanationAlgorithm`\
        \ = 'shap', these additional columns will be added:\n      triplets of (`Explanation_<i>_feature_name`,\n\
        \      `Explanation_<i>_feature_value`, and `Explanation_<i>_strength`) for\
        \ `i` ranging\n      from 1 to `maxExplanations`, `shap_remaining_total` and\
        \ `shap_base_value`. Binary\n      classification projects will also have\
        \ `explained_class`, the class for which\n      positive SHAP values imply\
        \ an increased probability.\n"
      operationId: projectsPredictions_retrieve
      parameters:
      - description: Required in multiclass projects with SHAP prediction explanations.
          This parameter specifies which of the target classes (levels) you would
          like to retrieve explanations for. This will NOT affect a non-multiclass
          project.
        in: query
        name: shapMulticlassLevel
        required: false
        schema:
          type: string
        x-versionadded: v2.22
      - description: The id of the prediction record to retrieve. If you have the
          jobId, you can retrieve the predictionId using :http:get:`/api/v2/projects/(projectId)/predictJobs/(jobId)/`.
        in: path
        name: predictionId
        required: true
        schema:
          type: string
      - description: The id of the project the prediction belongs to.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          - text/csv
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionRetrieveResponse'
          description: Predictions that have previously been computed.
          headers:
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - application/json
                - text/csv
                type: string
        '404':
          description: No prediction data found.
      summary: Get a completed set of predictions.
      tags:
      - predictions
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/predictionsMetadata/:
    get:
      description: Use the ID of a metadata object to get the complete set of predictions.
      operationId: projectsPredictionsMetadata_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. To specify no limit,
          use 0. The default may change and a maximum limit may be imposed without
          notice.
        in: query
        name: limit
        required: true
        schema:
          default: 1000
          minimum: 0
          type: integer
      - description: Dataset id used to create the predictions
        in: query
        name: predictionDatasetId
        required: false
        schema:
          type: string
      - description: Model id
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The project of the predictions.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveListPredictionMetadataObjectsResponse'
          description: The json array of prediction metadata objects.
      summary: Get a list of prediction metadata records.
      tags:
      - predictions
      x-versionadded: v2.16
  /api/v2/projects/{projectId}/predictionsMetadata/{predictionId}/:
    get:
      description: Use the ID of a metadata object to get the complete set of predictions.
      operationId: projectsPredictionsMetadata_retrieve
      parameters:
      - description: The id of the prediction record to retrieve. If you have the
          jobId, you can retrieve the predictionId using :http:get:`/api/v2/projects/(projectId)/predictJobs/(jobId)/`.
        in: path
        name: predictionId
        required: true
        schema:
          type: string
      - description: The id of the project the prediction belongs to.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrievePredictionMetadataObject'
          description: Prediction metadata object.
        '404':
          description: Training predictions not found.
      summary: Retrieve metadata for a set of predictions.
      tags:
      - predictions
      x-versionadded: v2.16
  /api/v2/projects/{projectId}/primeFiles/:
    get:
      description: List all DataRobot Prime files available for download
      operationId: projectsPrimeFiles_list
      parameters:
      - description: this many results will be skipped
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: at most this many results are returned. To specify no limit,
          use 0. The default may change and a maximum limit may be imposed without
          notice.
        in: query
        name: limit
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: if specified only Prime files approximating the specified parent
          model will be returned; otherwise all applicable Prime files will be returned.
        in: query
        name: parentModelId
        required: false
        schema:
          type: string
      - description: if specified only Prime files with code used in the specified
          prime model will be returned; otherwise all applicable Prime files will
          be returned
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: the project to list available files for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrimeFileListResponse'
          description: ''
      summary: Get Prime Files
      tags:
      - models
      x-versionadded: v2.4
    post:
      description: Request creation and validation of source code from a Prime model
      operationId: projectsPrimeFiles_create
      parameters:
      - description: the project the Prime model belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrimeFileCreate'
      responses:
        '202':
          description: prime validation job added to queue. See the Location header.
          headers:
            Location:
              description: a url that can be polled to check the status of prime validation
                job
              schema:
                format: url
                type: string
      summary: Create a Prime File
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/primeFiles/{primeFileId}/:
    get:
      description: Retrieve metadata about a DataRobot Prime file available for download
      operationId: projectsPrimeFiles_retrieve
      parameters:
      - description: the project the file belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the file to retrieve
        in: path
        name: primeFileId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrimeFileResponse'
          description: ''
      summary: Retrieve metadata about a DataRobot Prime file
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/primeFiles/{primeFileId}/download/:
    get:
      description: Download code from an existing Prime file
      operationId: projectsPrimeFilesDownload_list
      parameters:
      - description: the project the file belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the Prime file to download code from
        in: path
        name: primeFileId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a file with the executable code from
            the Prime file
          headers:
            Content-Disposition:
              description: Will be attachment;filename="<"filename">". The suggested
                filename will depend on the language Prime file was generated for.
              schema:
                type: string
      summary: Download Code
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/primeModels/:
    get:
      description: List all Prime models in a project
      operationId: projectsPrimeModels_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: the project to list models from
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrimeModelListResponse'
          description: ''
      summary: List all Prime models in a project
      tags:
      - models
      x-versionadded: v2.4
    post:
      description: 'Create a Prime model using a particular ruleset.


        DataRobot Prime is not available for multiclass projects.


        Once rulesets approximating a parent model have been created, using POST /api/v2/projects/(projectId)/models/(modelId)/primeRulesets/,
        this route will allow creation of a Prime model using one of those rulesets.


        Available rulesets can be retrieved via GET /api/v2/projects/(projectId)/models/(modelId)/primeRulesets/.'
      operationId: projectsPrimeModels_create
      parameters:
      - description: the project in which to create the model
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrimeModelCreatePayload'
      responses:
        '202':
          description: Prime model creation job successfully added to queue. See the
            Location header.
          headers:
            Location:
              description: a url that can be polled to check the status of the job
              schema:
                format: url
                type: string
      summary: Create a Prime Model from a Ruleset
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/primeModels/{modelId}/:
    get:
      description: Retrieve a Prime model details
      operationId: projectsPrimeModels_retrieve
      parameters:
      - description: the project to retrieve the model from
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the model to retrieve
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrimeModelDetailsRetrieveResponse'
          description: Prime models are an extension of models, so the response includes
            all attributes that would be in a response to GET /api/v2/projects/(projectId)/models/(modelId)/
            as well as some additional ones.
      summary: Retrieve a Prime model details
      tags:
      - models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/ratingTableModels/:
    get:
      description: Lists all the models from a project that have rating tables
      operationId: projectsRatingTableModels_list
      parameters:
      - description: If specified, the returned models will only have scores for this
          metric. If not, all metrics will be included.
        in: query
        name: withMetric
        required: false
        schema:
          type: string
      - description: If specified, will return metric scores for models trained into
          validation/holdout for projects that do not have stacked predictions.
        in: query
        name: showInSampleScores
        required: false
        schema:
          default: false
          type: boolean
        x-versionadded: v2.31
      - description: If specified, filters for models with a model type matching `name`.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: If specified, filters for models with a matching sample percentage.
        in: query
        name: samplePct
        required: false
        schema:
          type: number
      - description: If specified, filters for models marked as starred.
        in: query
        name: isStarred
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        x-versionadded: v2.13
      - description: A comma-separated list of metrics to sort by. If metric is prefixed
          with a '-', models are sorted by this metric in descending order, otherwise
          are sorted in ascending order. Valid sorting metrics are `metric` and `samplePct`.
          Use of `metric` sorts models by metric value selected for this project using
          the validation score. Use of the prefix accounts for the direction of the
          metric, so `-metric` will sort in order of decreasing 'goodness', which
          may be opposite to the natural numerical order. If not specified, `-metric`
          will be used.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - metric
          - -metric
          - samplePct
          - -samplePct
          type: string
      - description: the project to list models from
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/RatingTableModelDetailsResponse'
                type: array
          description: "The response will include a json list of models in the same\
            \ format as\n     those from GET /api/v2/projects/(projectId)/ratingTableModels/(modelId)/."
      summary: List Rating Table Models
      tags:
      - models
      x-versionadded: v2.0
    post:
      description: Create a new rating table model from a validated rating table record
      operationId: projectsRatingTableModels_create
      parameters:
      - description: the project that owns this data
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRatingTableModel'
      responses:
        '202':
          description: the request was understood and accepted, and is now being worked
            on
          headers:
            Location:
              description: a url of an asynchronous operation status object that can
                be polled to check the status of the job validating the new rating
                table
              schema:
                format: url
                type: string
      summary: Create New Models From A Rating Table
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/ratingTableModels/{modelId}/:
    get:
      description: Look up a particular rating table model
      operationId: projectsRatingTableModels_retrieve
      parameters:
      - description: the project to retrieve the model from
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the model to retrieve
        in: path
        name: modelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingTableModelDetailsResponse'
          description: ''
      summary: Retrieve Rating Table Model
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/ratingTables/:
    get:
      description: "List RatingTable objects for a project.\n    These contain metadata\
        \ about the rating table and the location at which the corresponding rating\n\
        \     table file can be retrieved."
      operationId: projectsRatingTables_list
      parameters:
      - description: optional. If specified, only rating tables with this parentModelId
          will be returned
        in: query
        name: parentModelId
        required: false
        schema:
          type: string
      - description: optional. If specified, only rating tables with this modelId
          will be returned
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: 'optional (default: 0), this many results will be skipped'
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: 'optional (default: no limit), at most this many results are
          returned. To specify no limit, use 0. The default may change and a maximum
          limit may be imposed without notice.'
        in: query
        name: limit
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingTableListResponse'
          description: ''
      summary: List Rating Tables For The Project
      tags:
      - models
      x-versionadded: v2.0
    post:
      description: 'Create a new rating table from a rating table file

        This will create a new rating table, regardless of whether the validation
        succeeds.

        The rating table object will have a validationError which will be left blank
        in the case of successful validation.'
      operationId: projectsRatingTables_create
      parameters:
      - description: the project that owns this data
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadRatingTable'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingTableCreateResponse'
          description: the request was understood and accepted, and is now being worked
            on
          headers:
            Location:
              description: a url of an asynchronous operation status object that can
                be polled to check the status of the job validating the new rating
                table
              schema:
                format: url
                type: string
      summary: Upload Modified Rating Table File
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/ratingTables/{ratingTableId}/:
    get:
      description: Retrieves a rating table
      operationId: projectsRatingTables_retrieve
      parameters:
      - description: the project that owns this data
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the rating table ID to retrieve the source file from
        in: path
        name: ratingTableId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingTableRetrieveResponse'
          description: ''
      summary: Retrieve Rating Table Information
      tags:
      - models
      x-versionadded: v2.0
    patch:
      description: Rating tables may only be updated if they have not yet been used
        to create a model.
      operationId: projectsRatingTables_patch
      parameters:
      - description: the project that owns this data
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the rating table ID to retrieve the source file from
        in: path
        name: ratingTableId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RatingTableUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingTableRetrieveResponse'
          description: "On success, will return the modified rating table record in\
            \ the same\n     format as GET /api/v2/projects/(projectId)/ratingTables/(ratingTableId)/"
      summary: Update an uploaded rating table
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/ratingTables/{ratingTableId}/file/:
    get:
      description: Retrieve the CSV file for the rating table
      operationId: projectsRatingTablesFile_list
      parameters:
      - description: the project that owns this data
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: the rating table ID to retrieve the source file from
        in: path
        name: ratingTableId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a file containing the rating table
            in csv format
      summary: Retrieve Rating Table File
      tags:
      - models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/recommendedModels/:
    get:
      description: Retrieves all of the current recommended models for the project
      operationId: projectsRecommendedModels_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/RecommendedModelResponse'
                type: array
          description: The list of recommended models
      summary: List recommended models for the project
      tags:
      - models
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/recommendedModels/recommendedModel/:
    get:
      description: This route returns the simplest recommended model available. To
        see all the available recommended models, use :http:get:`/api/v2/projects/(projectId)/recommendedModels/`
      operationId: projectsRecommendedModelsRecommendedModel_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedModelResponse'
          description: The recommended model
      summary: Get recommended model
      tags:
      - models
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/relationshipQualityAssessments/:
    post:
      description: Submit a job to assess quality of relationship configuration within
        a feature discovery project.
      operationId: projectsRelationshipQualityAssessments_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationshipQualityAssessmentsCreate'
      responses:
        '202':
          description: Relationship quality assessment has successfully started. See
            the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unable to process the request
      summary: Submit a relationship quality assessment job.
      tags:
      - projects
      x-versionadded: v2.30
  /api/v2/projects/{projectId}/relationshipsConfiguration/:
    get:
      description: Retrieve relationships configuration for a project
      operationId: projectsRelationshipsConfiguration_list
      parameters:
      - description: Id of Secondary Dataset Configuration
        in: query
        name: configId
        required: false
        schema:
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipsConfigResponse'
          description: Project relationships configuration.
        '404':
          description: Data was not found.
      summary: Retrieve relationships configuration for a project
      tags:
      - projects
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/ruleFitFiles/:
    get:
      description: List all RuleFit code files available for download
      operationId: projectsRuleFitFiles_list
      parameters:
      - description: if specified only RuleFit code files with code used in the specified
          RuleFit model will be returned; otherwise all applicable RuleFit files will
          be returned
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: This many files will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many files are returned.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          type: integer
      - description: the project to list available files for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleFitCodeFileListResponse'
          description: ''
      summary: Get RuleFit Code Files
      tags:
      - models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Disables Prime Model Creation / Enables Scoring Rules for All
          RuleFit Models
        enabled_by_default: true
        maturity: GA_ALL
        name: DEPRECATE_PRIME_MODELS
      x-versionadded: v2.30
    post:
      description: Request creation and validation of source code from a RuleFit model
      operationId: projectsRuleFitFiles_create
      parameters:
      - description: the project the file belongs to
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleFitCodeFileCreate'
      responses:
        '202':
          description: RuleFit code validation job added to queue. See the Location
            header.
          headers:
            Location:
              description: a url that can be polled to check the status of RuleFit
                code validation job
              schema:
                format: url
                type: string
      summary: Create a RuleFit Code File
      tags:
      - models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Disables Prime Model Creation / Enables Scoring Rules for All
          RuleFit Models
        enabled_by_default: true
        maturity: GA_ALL
        name: DEPRECATE_PRIME_MODELS
      x-versionadded: v2.30
  /api/v2/projects/{projectId}/ruleFitFiles/{ruleFitFileId}/:
    get:
      description: Get information about a  RuleFit code file available for download
      operationId: projectsRuleFitFiles_retrieve
      parameters:
      - description: the ID of the file
        in: path
        name: ruleFitFileId
        required: true
        schema:
          type: string
      - description: the project to list available files for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleFitCodeFileResponse'
          description: ''
      summary: Get RuleFit Code File Information
      tags:
      - models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Disables Prime Model Creation / Enables Scoring Rules for All
          RuleFit Models
        enabled_by_default: true
        maturity: GA_ALL
        name: DEPRECATE_PRIME_MODELS
      x-versionadded: v2.30
  /api/v2/projects/{projectId}/ruleFitFiles/{ruleFitFileId}/download/:
    get:
      description: Download code from an existing RuleFit file
      operationId: projectsRuleFitFilesDownload_list
      parameters:
      - description: the ID of the file
        in: path
        name: ruleFitFileId
        required: true
        schema:
          type: string
      - description: the project to list available files for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The response will contain a file with the executable code from
            the RuleFit model
          headers:
            Content-Disposition:
              description: Will be attachment;filename="<"filename">". The suggested
                filename will depend on the language RuleFit file was generated for.
              schema:
                type: string
      summary: Download RuleFit Code
      tags:
      - models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Disables Prime Model Creation / Enables Scoring Rules for All
          RuleFit Models
        enabled_by_default: true
        maturity: GA_ALL
        name: DEPRECATE_PRIME_MODELS
      x-versionadded: v2.30
  /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/:
    get:
      description: List all secondary dataset configurations for a project, optionally
        filtered by feature list id.
      operationId: projectsSecondaryDatasetsConfigurations_list
      parameters:
      - description: feature list ID of the model
        in: query
        name: featurelistId
        required: false
        schema:
          type: string
      - description: ID of the model
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 0
          type: integer
      - description: Include deleted records.
        in: query
        name: includeDeleted
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecondaryDatasetConfigListResponse'
          description: List of secondary dataset configurations.
        '404':
          description: Data is not found.
        '422':
          description: Unable to process the request
      summary: List all secondary dataset configurations for a project
      tags:
      - projects
      x-versionadded: v2.20
    post:
      description: Create secondary dataset configurations for a project.
      operationId: projectsSecondaryDatasetsConfigurations_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecondaryDatasetCreate'
      responses:
        '200':
          description: Secondary dataset configuration created with allowable type
            mismatches
        '201':
          description: Secondary dataset configuration created with no errors.
        '204':
          description: Validation of secondary dataset configuration is successful
        '422':
          description: Validation of secondary dataset configuration failed.
      summary: Create secondary dataset configurations for a project.
      tags:
      - projects
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/:
    delete:
      description: Soft deletes a secondary dataset configuration.
      operationId: projectsSecondaryDatasetsConfigurations_delete
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Secondary dataset configuration ID
        in: path
        name: secondaryDatasetConfigId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Secondary dataset configuration successfully soft deleted.
        '404':
          description: Data is not found.
        '409':
          description: Dataset has already been deleted
      summary: Soft deletes a secondary dataset configuration.
      tags:
      - projects
      x-versionadded: v2.21
    get:
      description: Retrieve secondary dataset configuration by ID.
      operationId: projectsSecondaryDatasetsConfigurations_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Secondary dataset configuration ID
        in: path
        name: secondaryDatasetConfigId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSecondaryDatasetConfigResponse'
          description: Secondary dataset configuration.
        '404':
          description: Data is not found.
        '422':
          description: Unable to process the request
      summary: Retrieve secondary dataset configuration by ID.
      tags:
      - projects
      x-versionadded: v2.20
  /api/v2/projects/{projectId}/segmentChampion/:
    put:
      description: Update champion model for a segment project.
      operationId: projectsSegmentChampion_putMany
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SegmentChampionModelUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentChampionModelUpdateResponse'
          description: The ID of Combined model that has been updated with new segment
            champion model.
      summary: Update champion model for a segment project.
      tags:
      - models
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/segmentationTaskJobResults/{segmentationTaskId}/:
    get:
      description: Retrieve the statuses of segmentation task jobs associated with
        the ID.
      operationId: projectsSegmentationTaskJobResults_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the segmentation task to check the status of.
        in: path
        name: segmentationTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentationResultsResponse'
          description: ''
      summary: Retrieve segmentation task statuses.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/segmentationTasks/:
    get:
      description: List all segmentation tasks created for the project.
      operationId: projectsSegmentationTasks_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          maximum: 20
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentationTaskListResponse'
          description: ''
      summary: List segmentation tasks.
      tags:
      - projects
      x-versionadded: v2.27
    post:
      description: Create segmentation tasks for the dataset used in the project.
      operationId: projectsSegmentationTasks_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SegmentationTaskCreate'
      responses:
        '202':
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Create segmentation tasks.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/segmentationTasks/{segmentationTaskId}/:
    get:
      description: Retrieve information about a segmentation task.
      operationId: projectsSegmentationTasks_retrieve
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the segmentation task.
        in: path
        name: segmentationTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentationTaskResponse'
          description: ''
      summary: Retrieve segmentation task.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/segmentationTasks/{segmentationTaskId}/mappings/:
    get:
      description: Retrieve the seriesId to segmentId mappings for a Segmentation
        Task.
      operationId: projectsSegmentationTasksMappings_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          maximum: 20
          minimum: 1
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The ID of the segmentation task.
        in: path
        name: segmentationTaskId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentationTaskSegmentMappingsResponse'
          description: ''
      summary: Retrieve seriesId to segmentId mappings.
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/segments/{segmentId}/:
    patch:
      description: The only supported operation right now is segment restart, which
        removes existing child segment project and starts another child project instead
        for the given segment. Should be only used for child segments which are stuck
        during project startup or upload.
      operationId: projectsSegments_patch
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The name of the segment
        in: path
        name: segmentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectSegmentUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSegmentUpdateResponse'
          description: The segment is updated.
      summary: Update child segment project.
      tags:
      - projects
      x-versionadded: v2.28
  /api/v2/projects/{projectId}/shapMatrices/:
    get:
      description: Get a list of available SHAP matrix records.
      operationId: projectsShapMatrices_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShapMatrixListResponse'
          description: ''
      summary: List SHAP matrix records.
      tags:
      - insights
      x-versionadded: v2.21
    post:
      description: Submit a request to calculate a matrix with SHAP based prediction
        explanations scores.
      operationId: projectsShapMatrices_create
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShapMatrixPayload'
      responses:
        '202':
          description: Job submitted. See Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
      summary: Calculate a matrix with SHAP based prediction explanations scores.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/shapMatrices/{shapMatrixId}/:
    get:
      description: Get matrix with SHAP prediction explanations scores.
      operationId: projectsShapMatrices_retrieve
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The SHAP matrix ID.
        in: path
        name: shapMatrixId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShapMatrixRetrieveResponse'
            text/csv:
              schema:
                type: string
          description: ''
      summary: Get matrix with SHAP prediction explanations scores.
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/status/:
    get:
      description: Check the status of a project
      operationId: projectsStatus_list
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectStatusResponse'
          description: The project status
      summary: Check project status
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/timeSeriesFeatureLog/:
    get:
      description: 'Retrieve the feature derivation log content and log length for
        a time series project as JSON.


        The Time Series Feature Log provides details about the feature generation
        process for a time series project. It includes information about which features
        are generated and their priority,as well as the detected properties of the
        time series data such as whether the series is stationary, and periodicities
        detected.


        This route is only supported for time series projects that have finished partitioning.


        The feature derivation log will include information about:


        * Detected stationarity of the series, e.g., ``Series detected as non-stationary``

        * Detected presence of multiplicative trend in the series, e.g., ``Multiplicative
        trend detected``

        * Detected periodicities in the series, e.g., ``Detected periodicities: 7
        day``

        * Maximum number of feature to be generated, e.g., ``Maximum number of feature
        to be generated is 1440``

        * Window sizes used in rolling statistics / lag extractors, e.g., ``The window
        sizes chosen to be: 2 months``

        * Features that are specified as known-in-advance, e.g., ``Variables treated
        as apriori: holiday``

        * Details about features generated as timeseries features, and their priority,
        e.g., ``Generating feature "date (actual)" from "date" (priority: 1)``

        * Details about why certain variables are transformed in the input data, e.g.,
        ``Generating variable "y (log)" from "y" because multiplicative trend is detected``'
      operationId: projectsTimeSeriesFeatureLog_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeSeriesFeatureLogListControllerResponse'
          description: ''
      summary: Retrieve the feature derivation log content and log length for a time
        series project as JSON.
      tags:
      - datetime_partitioning
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/timeSeriesFeatureLog/file/:
    get:
      description: 'Retrieve a text file containing the time series project feature
        log.


        The Time Series Feature Log provides details about the feature generation
        process for a time series project. It includes information about which features
        are generated and their priority,as well as the detected properties of the
        time series data such as whether the series is stationary, and periodicities
        detected.


        This route is only supported for time series projects that have finished partitioning.


        The feature derivation log will include information about:


        * Maximum number of feature to be generated, e.g., ``Limit on the maximum
        number of feature in this project is 500``

        * Number of derived features tested during the feature generation process,
        e.g., ``Total number of derived features during the feature generation process
        is 571``

        * Number of generated features removed during the feature reduction process
        e.g. ``Total number of features removed during the feature reduction process
        is 472``

        * Number of remaining features after the combined feature generation and reduction
        process, e.g., ``The finalized number of features is 99``

        * Detected stationarity of the series, e.g., ``Series detected as non-stationary``

        * Detected presence of multiplicative trend in the series, e.g., ``Multiplicative
        trend detected``

        * Detected periodicities in the series, e.g., ``Detected periodicities: 7
        day``

        * Window sizes used in rolling statistics / lag extractors, e.g., ``The window
        sizes chosen to be: 2 months (because the time step is 1 month and Feature
        Derivation Window is 2 months)``

        * Features that are specified as known-in-advance, e.g., ``Variables treated
        as apriori: holiday``

        * Details about why certain variables are transformed in the input data, e.g.,
        ``Generating variable "y (log)" from "y" because multiplicative trend is detected``

        * Details about features generated as time series features, and their priority,
        e.g., ``Generating feature "date (actual)" from "date" (priority: 1)``'
      operationId: projectsTimeSeriesFeatureLogFile_list
      parameters:
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers:
            Content-Disposition:
              description: '`attachment;filename=<filename>.txt` The suggested filename
                is dynamically generated'
              schema:
                type: string
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - text/plain
                type: string
      summary: Retrieve a text file containing the time series project feature log
      tags:
      - datetime_partitioning
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/trainingPredictions/:
    get:
      description: Get a list of training prediction records
      operationId: trainingPredictions_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Project ID to retrieve training predictions for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrainingPredictionsListResponse'
          description: A list of training prediction jobs
      summary: List training prediction jobs
      tags:
      - predictions
      x-versionadded: v2.8
    post:
      description: Create training data predictions
      operationId: projectsTrainingPredictions_create
      parameters:
      - description: Project ID to compute training predictions for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTrainingPrediction'
      responses:
        '202':
          description: Submitted successfully. See Location header.
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: "\n                - Model/Timeseries/Blender does not support\
            \ shap based prediction explanations\n                - Error message\
            \ from StackedPredictionRequestValidationError\n                - Could\
            \ not create training predictions job. Request with same parameters already\
            \ submitted.\n\n            "
      summary: Submits a job to compute predictions for training data
      tags:
      - predictions
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/trainingPredictions/{predictionId}/:
    get:
      description: Retrieve training predictions that have previously been computed
      operationId: computedTrainingPredictions_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Project ID to retrieve training predictions for
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Prediction ID to retrieve training predictions for
        in: path
        name: predictionId
        required: true
        schema:
          type: string
      - description: Requested MIME type for the returned data
        in: header
        name: Accept
        required: false
        schema:
          enum:
          - application/json
          - text/csv
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrainingPredictionsRetrieveResponse'
            text/csv:
              schema:
                description: 'The returned CSV columns is determined by project type.
                  For regression projects: "row_id", "partition_id" and "prediction".
                  For binary classification projects: "row_id", "partition_id", "prediction",
                  "<class_prefix><positive_class_label>" and "<class_prefix><negative_class_label>".For
                  multiclass projects: "row_id", "partition_id", "prediction" and
                  a "<class_prefix><class_label>" for each class. For multilabel projects:
                  "row_id", "partition_id" and for each class "prediction_<class_label>"
                  and "<class_prefix><class_label>". For time-series, these additional
                  columns will be added: "forecast_point", "forecast_distance" and
                  "timestamp". If "explanationAlgorithm" = "shap", these additional
                  columns will be added: triplets of ("Explanation_<i>_feature_name",
                  "Explanation_<i>_feature_value", and "Explanation_<i>_strength")
                  for "i" ranging from 1 to "maxExplanations", and "shap_remaining_total".
                  Binary classification projects will also have "explained_class",
                  the class for which positive SHAP values imply an increased probability.'
                type: string
          description: Training predictions encoded either as JSON or CSV
          headers:
            Content-Type:
              description: MIME type of the returned data
              schema:
                enum:
                - application/json
                - text/csv
                type: string
        '404':
          description: Job does not exist or is not completed
      summary: Retrieve training predictions
      tags:
      - predictions
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/typeTransformFeatures/:
    post:
      description: Create a new feature by changing the type of an existing one.
      operationId: projectsTypeTransformFeatures_create
      parameters:
      - description: The project to create the feature in.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureTransform'
      responses:
        '200':
          description: Creation has successfully started. See the Location header.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '422':
          description: Unable to process the request
      summary: Create a new feature by changing the type of an existing one.
      tags:
      - projects
      x-versionadded: v2.3
  /api/v2/recipes/:
    get:
      description: Get a list of the recipes available for given user.
      operationId: recipes_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: 'The attribute sort order applied to the returned recipes list:
          ''recipe_id'', ''name'', ''description'', ''dialect'', ''status'', ''recipe_type'',
          ''created_at'', ''created_by'', ''updated_at'', ''updated_by''. Prefix the
          attribute name with a dash to sort in descending order. e.g., orderBy=''-name''.
          Defaults to ''-created''.'
        in: query
        name: orderBy
        required: false
        schema:
          default: -updatedAt
          enum:
          - recipeId
          - -recipeId
          - name
          - -name
          - description
          - -description
          - dialect
          - -dialect
          - status
          - -status
          - recipeType
          - -recipeType
          - createdAt
          - -createdAt
          - createdBy
          - -createdBy
          - updatedAt
          - -updatedAt
          - updatedBy
          - -updatedBy
          type: string
      - description: Only return recipes with names that contain the specified string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: SQL dialect for Query Generator.
        in: query
        name: dialect
        required: false
        schema:
          oneOf:
          - enum:
            - snowflake
            - bigquery
            - spark-feature-discovery
            - databricks
            - spark
            type: string
          - items:
              enum:
              - snowflake
              - bigquery
              - spark-feature-discovery
              - databricks
              - spark
              type: string
            type: array
      - description: Status used for filtering recipes.
        in: query
        name: status
        required: false
        schema:
          oneOf:
          - enum:
            - draft
            - preview
            - published
            type: string
          - items:
              enum:
              - draft
              - preview
              - published
              type: string
            type: array
      - description: Type of the recipe workflow.
        in: query
        name: recipeType
        required: false
        schema:
          oneOf:
          - enum:
            - wrangling
            - Wrangling
            - WRANGLING
            - featureDiscovery
            - FeatureDiscovery
            - FEATURE_DISCOVERY
            - featureDiscoveryPrivatePreview
            - FeatureDiscoveryPrivatePreview
            - FEATURE_DISCOVERY_PRIVATE_PREVIEW
            type: string
          - items:
              enum:
              - wrangling
              - Wrangling
              - WRANGLING
              - featureDiscovery
              - FeatureDiscovery
              - FEATURE_DISCOVERY
              - featureDiscoveryPrivatePreview
              - FeatureDiscoveryPrivatePreview
              - FEATURE_DISCOVERY_PRIVATE_PREVIEW
              type: string
            type: array
      - description: Filter results to display only those created by user(s) associated
          with the specified ID.
        in: query
        name: creatorUserId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Filter results to display only those created by user(s) associated
          with the specified username.
        in: query
        name: creatorUsername
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipesListResponse'
          description: ''
      summary: List recipes.
      tags:
      - data_wrangling
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables recipe lifecycle management improvements, including manual
          and auto saving wrangling sessions, and viewing recipes for Use Case datasets
          in the Data tab.
        enabled_by_default: true
        maturity: GA_ALL
        name: UXR_RECIPES_IN_USECASE
      x-versionadded: v2.33
  /api/v2/recipes/fromDataStore/:
    post:
      description: Create a recipe which could be used for wrangling from a created
        fully reconfigured source of data. A `data source` specifies, via SQL query
        or selected table and schema data, which data to extract from the `data connection`
        (the location of data within a given endpoint) to use for modeling or predictions.
        A `data source` has one `data connection` and one `connector` but can have
        many `datasets`.
      operationId: recipesFromDataStore_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeFromDataSourceCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: Data source and recipe created successfully.
      summary: Create a recipe and a data source from given data store.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/fromDataset/:
    post:
      description: Create a recipe which could be used for wrangling from given dataset.
        Deepcopy the dataset's recipe if available.Otherwise create a new recipe reusing
        the dataset's data source.A `data source` specifies, via SQL query or selected
        table and schema data, which data to extract from the `data connection` (the
        location of data within a given endpoint) to use for modeling or predictions.
        A `data source` has one `data connection` and one `connector` but can have
        many `datasets`.
      operationId: recipesFromDataset_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericRecipeFromDataset'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: Recipe created successfully.
        '422':
          description: You can't specify `dialect` or `inputs` when source Recipe
            is available.
      summary: Create a recipe given dataset.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/fromRecipe/:
    post:
      description: Shallow copy the given recipe, reusing existing data sources. Implicitly
        creates duplicate of wrangling session.
      operationId: recipesFromRecipe_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeFromRecipeCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: Recipe created successfully.
      summary: Clone given wrangling recipe.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/:
    delete:
      description: Marks the wrangling recipe with a given ID as deleted.
      operationId: recipes_delete
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeSettingsUpdate'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeSettingsResponse'
          description: Successfully deleted.
      summary: Deletes the wrangling recipe.
      tags:
      - data_wrangling
      x-versionadded: v2.33
    get:
      description: Retrieve a wrangling recipe given ID.
      operationId: recipes_retrieve
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: ''
      summary: Retrieve a wrangling recipe
      tags:
      - data_wrangling
      x-versionadded: v2.33
    patch:
      description: Patch a wrangling recipe name and description
      operationId: recipes_patch
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRecipe'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: ''
      summary: Patched wrangling recipe.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/downsampling/:
    put:
      description: Updates the downsampling directive in the recipe.Downsampling will
        be applied on top of the recipe during publishing.
      operationId: recipesDownsampling_putMany
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeDownsamplingUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: ''
        '422':
          description: Cannot modify published recipe.
      summary: Updates the downsampling in a recipe.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/inputs/:
    get:
      description: Gets inputs of the given recipe.
      operationId: recipesInputs_list
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeInputsResponse'
          description: ''
      summary: Gets inputs on a recipe.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/insights/:
    get:
      description: Retrieve recipe insights.
      operationId: recipesInsights_list
      parameters:
      - description: At most this many results are returned. The default may change
          and a maximum limit may be imposed without notice.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          maximum: 100
          minimum: 0
          type: integer
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefinexInsightsResponse'
          description: ''
      summary: Retrieve recipe insights.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/operations/{operationIndex}/:
    get:
      description: Returns an operation configuration with an additional *inputColumns*
        field to show the list of columns available at that stage.
      operationId: recipesOperations_retrieve
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      - description: The zero-based index of the operation.
        in: path
        name: operationIndex
        required: true
        schema:
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationDetails'
          description: ''
      summary: Retrieve a recipe operation details.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/preview/:
    get:
      description: Retrieve a wrangling preview given ID.
      operationId: recipesPreview_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipePreviewResponse'
          description: ''
      summary: Retrieve a wrangling preview.
      tags:
      - data_wrangling
      x-versionadded: v2.33
    post:
      description: "Starts the preview process for the recipe. Since this is an asynchronous\
        \ process this endpoint returns a status ID to use with the status endpoint\
        \ and a location header with the URL that can be polled for status.Launch\
        \ WranglingJob, which includes: \n1. InitialSamplingJob if it hasn\u2019t\
        \ been launched before\n2. Preview query itself\n3. Launch recipe eda job\n\
        \nInsights computation is launched implicitly if there was sampling specified\
        \ and no operations specified."
      operationId: recipesPreview_create
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptionalCredentialId'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunPreviewStatus'
          description: ''
        '422':
          description: Credentials were not provided and default credentials were
            not found.
      summary: Start the job that generates the preview of the data.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/settings/:
    patch:
      description: Updates some recipe settings applicable in the modeling stage.
      operationId: recipesSettings_patchMany
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeSettingsUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeSettingsResponse'
          description: ''
      summary: Updates recipe settings.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/sql/:
    post:
      description: Builds a SQL query for the recipe. Overrides operations to get
        the adjusted query without changing the recipe.
      operationId: recipesSql_create
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildRecipeSql'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildRecipeSqlResponse'
          description: ''
        '409':
          description: Input source data is not ready yet.
        '422':
          description: Failed to build SQL.
      summary: Build SQL query for the recipe.
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/registeredModels/:
    get:
      description: List registered models.
      operationId: registeredModels_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: A term to search for in registered model name
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: Registered models created on or after this timestamp
        in: query
        name: createdAtStartTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Registered models created before this timestamp. Defaults to
          the current time
        in: query
        name: createdAtEndTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Registered models modified on or after this timestamp
        in: query
        name: modifiedAtStartTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Registered models modified before this timestamp. Defaults to
          the current time
        in: query
        name: modifiedAtEndTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Name of the target to filter by
        in: query
        name: targetName
        required: false
        schema:
          type: string
      - description: Type of the target to filter by
        in: query
        name: targetType
        required: false
        schema:
          type: string
      - description: Email of the user that created registered model to filter by
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: Key to order result by
        in: query
        name: sortKey
        required: false
        schema:
          default: modifiedAt
          enum:
          - createdAt
          - modifiedAt
          - name
          type: string
      - description: Sort direction
        in: query
        name: sortDirection
        required: false
        schema:
          default: desc
          enum:
          - asc
          - desc
          type: string
      - description: If specified, limit results to registered models containing versions
          (model packages) for the leaderboard model with the specified ID.
        in: query
        name: compatibleWithLeaderboardModelId
        required: false
        schema:
          type: string
      - description: Return registered models that have versions (model packages)
          compatible with given model package ID. If used, will only return registered
          models which have versions that match `target.name`, `target.type`, `target.classNames`
          (for classification models), `modelKind.isTimeSeries`, and `modelKind.isMultiseries`
          of the specified model package.
        in: query
        name: compatibleWithModelPackageId
        required: false
        schema:
          type: string
      - description: Can be used with compatibleWithModelPackageId to request similar
          registered models that contain versions (model packages)that can be used
          as challenger models; for external model packages, instead of returning
          similar external model packages, similar DataRobot and Custom model packages
          will be retrieved.
        in: query
        name: forChallenger
        required: false
        schema:
          type: boolean
      - description: If specified, return any registered models containing one or
          more versions matching the prediction threshold used for binary classification
          models
        in: query
        name: predictionThreshold
        required: false
        schema:
          maximum: 1
          minimum: 0
          type: number
      - description: If specified, return any registered models that contain either
          imported (true) or non-imported (false) versions (model packages)
        in: query
        name: imported
        required: false
        schema:
          type: boolean
      - description: Can be used to filter registered models by what is supported
          by the prediction environment
        in: query
        name: predictionEnvironmentId
        required: false
        schema:
          type: string
      - description: Return models that contain versions matching a specific format
        in: query
        name: modelKind
        required: false
        schema:
          oneOf:
          - enum:
            - is_unsupervised_learning
            - is_time_series
            - is_multiseries
            - is_blender
            - is_anomaly_detection_model
            - is_feature_discovery
            - is_shap_supported_model
            - is_unsupervised_clustering
            - is_combined_model
            - is_unstructured
            type: string
          - items:
              enum:
              - is_unsupervised_learning
              - is_time_series
              - is_multiseries
              - is_blender
              - is_anomaly_detection_model
              - is_feature_discovery
              - is_shap_supported_model
              - is_unsupervised_clustering
              - is_combined_model
              - is_unstructured
              type: string
            type: array
      - description: If specified, only return models that have versions with specified
          build status
        in: query
        name: buildStatus
        required: false
        schema:
          enum:
          - inProgress
          - complete
          - failed
          type: string
      - description: If specified, only returns models that have versions in the specified
          stage.
        in: query
        name: stage
        required: false
        schema:
          enum:
          - Registered
          - Development
          - Staging
          - Production
          - Archived
          type: string
      - description: Return only global (accessible to all users in the organization)
          registered models or local(accessible only to the owner and the users with
          whom it has been explicitly shared)
        in: query
        name: isGlobal
        required: false
        schema:
          type: boolean
      - description: List of tag keys to filter by.
        in: query
        name: tagKeys
        required: false
        schema:
          type: string
      - description: List of tag values to filter by.
        in: query
        name: tagValues
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelListResponse'
          description: ''
      summary: List registered models.
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/:
    delete:
      description: Permanently archive a registered model and all of its versions
      operationId: registeredModels_delete
      parameters:
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Archive a registered model
      tags:
      - models
      x-versionadded: v2.32
    get:
      description: Retrieve info about a registered model.
      operationId: registeredModels_retrieve
      parameters:
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelResponse'
          description: ''
        '404':
          description: The registered model does not exist or the user does not have
            permission to view the model package.
      summary: Retrieve info about a registered model.
      tags:
      - models
      x-versionadded: v2.32
    patch:
      description: Update registered model
      operationId: registeredModels_patch
      parameters:
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisteredModelUpdate'
      responses:
        '200':
          description: ''
        '422':
          description: Unable to process the Registered Model update request
      summary: Update registered model
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/deployments/:
    get:
      description: List deployments associated with the given registered model
      operationId: registeredModelsDeployments_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Filter deployments with name matching search term
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: Key to order result by
        in: query
        name: sortKey
        required: false
        schema:
          default: createdAt
          enum:
          - createdAt
          - label
          type: string
      - description: Sort direction
        in: query
        name: sortDirection
        required: false
        schema:
          default: desc
          enum:
          - asc
          - desc
          type: string
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelDeploymentsListResponse'
          description: ''
      summary: List deployments associated with the given registered model
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this registered model and their roles on the registered model.
      operationId: registeredModelsSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The registered model's access control list.
        '404':
          description: Either the Registered Model does not exist or the user does
            not have permissions to view the Registered Model.
        '422':
          description: Both username and userId were specified
      summary: Get registered model's access control list
      tags:
      - models
      x-versionadded: v2.32
    patch:
      description: Set roles for users on this registered model.
      operationId: registeredModelsSharedRoles_patchMany
      parameters:
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: Roles updated successfully.
        '409':
          description: The request would leave the registered model without an owner.
        '422':
          description: One of the users in the request does not exist, or the request
            is otherwise invalid
      summary: Update registered model's controls
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/versions/:
    get:
      description: List registered model's versions.
      operationId: registeredModelsVersions_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Key to order result by
        in: query
        name: sortKey
        required: false
        schema:
          default: version
          enum:
          - version
          - modelType
          - status
          - createdAt
          - updatedAt
          type: string
      - description: Sort direction
        in: query
        name: sortDirection
        required: false
        schema:
          default: desc
          enum:
          - asc
          - desc
          type: string
      - description: Name of the target to filter by
        in: query
        name: targetName
        required: false
        schema:
          type: string
      - description: Type of the target to filter by
        in: query
        name: targetType
        required: false
        schema:
          type: string
      - description: A term to search for in version name, model name, or description
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: If specified, limit results to  versions (model packages) of
          the leaderboard model with the specified ID.
        in: query
        name: compatibleWithLeaderboardModelId
        required: false
        schema:
          type: string
      - description: Return versions compatible with given model package ID. If used,
          will only return versions that match `target.name`, `target.type`, `target.classNames`
          (for classification models), `modelKind.isTimeSeries`, and `modelKind.isMultiseries`
          of the specified model package
        in: query
        name: compatibleWithModelPackageId
        required: false
        schema:
          type: string
      - description: Can be used with compatibleWithModelPackageId to request similar
          versions that can be used as challenger models; for external model packages,
          instead of returning similar external model packages, similar DataRobot
          and Custom model packages will be retrieved
        in: query
        name: forChallenger
        required: false
        schema:
          type: boolean
      - description: Return versions with the specified prediction threshold used
          for binary classification models
        in: query
        name: predictionThreshold
        required: false
        schema:
          maximum: 1
          minimum: 0
          type: number
      - description: If specified, return either imported (true) or non-imported (false)
          versions (model packages)
        in: query
        name: imported
        required: false
        schema:
          type: boolean
      - description: Can be used to filter versions (model packages) by what is supported
          by the prediction environment
        in: query
        name: predictionEnvironmentId
        required: false
        schema:
          type: string
      - description: Return versions that match a specific format.
        in: query
        name: modelKind
        required: false
        schema:
          oneOf:
          - enum:
            - is_unsupervised_learning
            - is_time_series
            - is_multiseries
            - is_blender
            - is_anomaly_detection_model
            - is_feature_discovery
            - is_shap_supported_model
            - is_unsupervised_clustering
            - is_combined_model
            - is_unstructured
            type: string
          - items:
              enum:
              - is_unsupervised_learning
              - is_time_series
              - is_multiseries
              - is_blender
              - is_anomaly_detection_model
              - is_feature_discovery
              - is_shap_supported_model
              - is_unsupervised_clustering
              - is_combined_model
              - is_unstructured
              type: string
            type: array
      - description: If specified, filter versions by the build status.
        in: query
        name: buildStatus
        required: false
        schema:
          enum:
          - inProgress
          - complete
          - failed
          type: string
      - description: If specified, filter versions by the stage.
        in: query
        name: stage
        required: false
        schema:
          enum:
          - Registered
          - Development
          - Staging
          - Production
          - Archived
          type: string
      - description: If specified, filter versions by use-case id.
        in: query
        name: useCaseId
        required: false
        schema:
          type: string
      - description: Email of the user that created registered model version to filter
          by
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelVersionsListResponse'
          description: ''
      summary: List registered model's versions.
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/versions/{versionId}/:
    get:
      description: Get a registered model's version.
      operationId: registeredModelsVersions_retrieve
      parameters:
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      - description: ID of the registered model's version.
        in: path
        name: versionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageRetrieveResponse'
          description: ''
      summary: Get a registered model's version.
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/versions/{versionId}/deployments/:
    get:
      description: List all deployments associated with registered model version.
      operationId: registeredModelsVersionsDeployments_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          minimum: 0
          type: integer
      - description: Filter deployments with name matching search term
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: Key to order result by
        in: query
        name: sortKey
        required: false
        schema:
          default: createdAt
          enum:
          - createdAt
          - label
          type: string
      - description: Sort direction
        in: query
        name: sortDirection
        required: false
        schema:
          default: desc
          enum:
          - asc
          - desc
          type: string
      - description: ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      - description: ID of the registered model's version.
        in: path
        name: versionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelDeploymentsListResponse'
          description: ''
      summary: List all deployments associated with registered model version.
      tags:
      - models
      x-versionadded: v2.32
  /api/v2/relationshipsConfigurations/:
    post:
      description: Create a relationships configuration
      operationId: relationshipsConfigurations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationshipsConfigCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipsConfigResponse'
          description: ''
        '422':
          description: User input fails validation
      summary: Create a relationships configuration
      tags:
      - projects
      x-versionadded: v2.21
  /api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/:
    delete:
      description: Delete a relationships configuration
      operationId: relationshipsConfigurations_delete
      parameters:
      - description: Id of the relationships configuration to delete
        in: path
        name: relationshipsConfigurationId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '404':
          description: Relationships configuration not found
      summary: Delete a relationships configuration
      tags:
      - projects
      x-versionadded: v2.21
    get:
      description: Retrieve a relationships configuration
      operationId: relationshipsConfigurations_retrieve
      parameters:
      - description: Id of the relationships configuration to delete
        in: path
        name: relationshipsConfigurationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipsConfigResponse'
          description: ''
        '404':
          description: Relationships configuration cannot be found
      summary: Retrieve a relationships configuration
      tags:
      - projects
      x-versionadded: v2.21
    put:
      description: Replace a relationships configuration
      operationId: relationshipsConfigurations_put
      parameters:
      - description: Id of the relationships configuration to delete
        in: path
        name: relationshipsConfigurationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationshipsConfigCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipsConfigResponse'
          description: ''
        '422':
          description: User input fails validation
      summary: Replace a relationships configuration
      tags:
      - projects
      x-versionadded: v2.21
  /api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/projects/{projectId}/:
    get:
      description: Retrieve the relationships configuration with extended information
      operationId: relationshipsConfigurations_retrieveExtended
      parameters:
      - description: Flag indicating whether or not to include relationship quality
          information in the returned result
        in: query
        name: includeRelationshipQuality
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The project ID
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The relationships configuration ID
        in: path
        name: relationshipsConfigurationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedRelationshipsConfigRetrieve'
          description: ''
      summary: Retrieve the relationships configuration with extended information
        in the context of a project
      tags:
      - projects
      x-versionadded: v2.31
  /api/v2/remoteEvents/:
    post:
      description: Post an event from a remote deployment.
      operationId: remoteEvents_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteEventCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRemoteEventResponse'
          description: The event was created.
        '404':
          description: The deployment was not found.
        '422':
          description: Unable to process the request instructions or failed to post
            the event.
      summary: Post a remote deployment event
      tags:
      - notifications
      x-versionadded: v2.21
  /api/v2/scheduledJobs/:
    get:
      description: Get a list of scheduled batch prediction jobs a user can view
      operationId: scheduledJobs_list
      parameters:
      - description: The number of scheduled jobs to skip. Defaults to 0.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of scheduled jobs (max 100) to return. Defaults to
          20
        in: query
        name: limit
        required: true
        schema:
          default: 20
          maximum: 100
          minimum: 0
          type: integer
      - description: The order to sort the scheduled jobs. Defaults to order by last
          successful run timestamp in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          default: name
          type: string
      - description: Case insensitive search against scheduled jobs name or type name.
        in: query
        name: search
        required: false
        schema:
          default: ''
          type: string
      - description: Filter by the prediction integration deployment ID. Ignored for
          non prediction integration type ID.
        in: query
        name: deploymentId
        required: false
        schema:
          type: string
      - description: filter by scheduled job type ID.
        in: query
        name: typeId
        required: false
        schema:
          default: datasetRefresh
          enum:
          - datasetRefresh
          type: string
      - description: Which user field to filter with.
        in: query
        name: queryByUser
        required: false
        schema:
          default: createdBy
          enum:
          - createdBy
          - updatedBy
          type: string
      - description: Filter jobs using the enabled field. If `true`, only enabled
          jobs are returned, otherwise if `false`, only disabled jobs are returned.
          The default returns both enabled and disabled jobs.
        in: query
        name: filterEnabled
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJobsListResponse'
          description: A list of scheduled batch prediction jobs
      summary: List scheduled deployment batch prediction jobs a user can view
      tags:
      - predictions
      x-versionadded: v2.21
  /api/v2/ssoConfigurations/:
    get:
      description: List the sso configurations that correspond to provided conditions.
      operationId: ssoConfigurations_list
      parameters:
      - description: The number of records to skip over.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: The ID of the organization.
        in: query
        name: orgId
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSsoConfigurationResponse'
          description: List of sso configurations.
      summary: List sso configurations.
      tags:
      - sso_configuration
      x-versionadded: v2.21
    post:
      description: Create an SSO configuration for a specific organization
      operationId: ssoConfigurations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSsoConfiguration'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnhancedSsoConfigurationResponse'
          description: Configuration created successfully
      summary: Create an SSO configuration for a specific organization
      tags:
      - sso_configuration
      x-versionadded: v2.21
  /api/v2/ssoConfigurations/{configurationId}/:
    get:
      description: Retrieve SSO configuration of a specific organization.
      operationId: ssoConfigurations_retrieve
      parameters:
      - description: The ID of the organization to retrieve SSO config for.
        in: path
        name: configurationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnhancedSsoConfigurationResponse'
          description: SSO configuration.
      summary: Retrieve SSO configuration of a specific organization.
      tags:
      - sso_configuration
      x-versionadded: v2.21
    patch:
      description: Update an SSO configuration for a specific organization.
      operationId: ssoConfigurations_patch
      parameters:
      - description: The ID of the organization to retrieve SSO config for.
        in: path
        name: configurationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSsoConfiguration'
      responses:
        '200':
          description: ''
      summary: Update an SSO configuration for a specific organization.
      tags:
      - sso_configuration
      x-versionadded: v2.21
  /api/v2/status/:
    get:
      description: List the async tasks that are currently running for your account
      operationId: status_list
      parameters:
      - description: This many results will be skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. If 0, all results.
        in: query
        name: limit
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusListResponse'
          description: The list of statuses
      summary: List tasks
      tags:
      - jobs
      x-versionadded: v2.15
  /api/v2/status/{statusId}/:
    delete:
      description: Destroy an async status object
      operationId: status_delete
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
      summary: Delete a task
      tags:
      - jobs
      x-versionadded: v2.3
    get:
      description: Check the status of an asynchronous task such as project creation
      operationId: status_retrieve
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusRetrieveResponse'
          description: The status of the asynchronous task
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '303':
          description: Task is completed, see Location header for the location of
            a new resource
      summary: Get task status
      tags:
      - jobs
      x-versionadded: v2.3
  /api/v2/stringEncryptions/:
    post:
      description: DataRobot does not store your credentials when accessing external
        data stores. Instead you first encrypt your sensitive information with DataRobot
        and then, when accessing those data stores, supply the encrypted credentials.
        DataRobot will decrypt your credentials and use them to establish a connection
        to your data store.
      operationId: stringEncryptions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StringEncryption'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringEncryptionResponse'
          description: Encryted string.
      summary: Encrypt a string which DataRobot can decrypt.
      tags:
      - utilities
      x-versionadded: v2.4
  /api/v2/usageDataExports/:
    post:
      description: Create a customer usage data artifact request. Requires "CAN_ACCESS_USER_ACTIVITY"
        permission. Returns async task status URL as a "Location" header. Async task
        status should be polled in order to retrieve artifact id.
      operationId: usageDataExports_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsageDataExport'
      responses:
        '202':
          description: Customer usage data artifact creation started. Status can be
            tracked at Location field in headers.
        '400':
          description: Artifact creation process encountered a problem.
      summary: Create a customer usage data artifact request. Requires "CAN_ACCESS_USER_ACTIVITY"
        permission.
      tags:
      - analytics
      x-versionadded: v2.11
  /api/v2/usageDataExports/supportedEvents/:
    get:
      description: Describe supported available audit events with which to filter
        result data.
      operationId: usageDataExportsSupportedEvents_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageDataEventsListResponse'
          description: A list of supported available audit events.
      summary: Describe supported available audit events with which to filter result
        data.
      tags:
      - analytics
      x-versionadded: v2.11
  /api/v2/usageDataExports/{artifactId}/:
    get:
      description: Retrieve a prepared customer usage data artifact. Requires "CAN_ACCESS_USER_ACTIVITY"
        permission.
      operationId: usageDataExports_retrieve
      parameters:
      - description: The ID of the generated artifact to retrieve.
        in: path
        name: artifactId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageDataRetrieveResponse'
          description: An artifact file in .zip format.
        '400':
          description: Usage data artifact retrieval failed.
        '404':
          description: Requested artifact does not exist.
      summary: Retrieve a prepared customer usage data artifact.
      tags:
      - analytics
      x-versionadded: v2.11
  /api/v2/useCases/:
    get:
      description: Retrieve a list of Use Cases.
      operationId: useCases_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Only return Use Cases with names that match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Only return Use Cases associated with the given project id.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: Only return Use Cases associated with the given app.
        in: query
        name: applicationId
        required: false
        schema:
          type: string
      - description: '[DEPRECATED - replaced with order_by] The order to sort the
          Use Cases.'
        in: query
        name: sort
        required: true
        schema:
          default: id
          enum:
          - -applicationsCount
          - -createdAt
          - -createdBy
          - -datasetsCount
          - -description
          - -id
          - -name
          - -notebooksCount
          - -playgroundsCount
          - -projectsCount
          - -updatedAt
          - -updatedBy
          - -vectorDatabasesCount
          - applicationsCount
          - createdAt
          - createdBy
          - datasetsCount
          - description
          - id
          - name
          - notebooksCount
          - playgroundsCount
          - projectsCount
          - updatedAt
          - updatedBy
          - vectorDatabasesCount
          type: string
        x-versiondeprecated: v2.32
      - description: The order to sort the Use Cases.
        in: query
        name: orderBy
        required: true
        schema:
          default: id
          enum:
          - -applicationsCount
          - -createdAt
          - -createdBy
          - -datasetsCount
          - -description
          - -id
          - -name
          - -notebooksCount
          - -playgroundsCount
          - -projectsCount
          - -updatedAt
          - -updatedBy
          - -vectorDatabasesCount
          - applicationsCount
          - createdAt
          - createdBy
          - datasetsCount
          - description
          - id
          - name
          - notebooksCount
          - playgroundsCount
          - projectsCount
          - updatedAt
          - updatedBy
          - vectorDatabasesCount
          type: string
      - description: The filtered Usecases to return by its type.
        in: query
        name: usecaseType
        required: true
        schema:
          default: all
          enum:
          - all
          - general
          - walkthrough
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseListResponse'
          description: Use Cases retrieved successfully.
        '403':
          description: User does not have access to this functionality.
      summary: Retrieve a list of Use Cases.
      tags:
      - use_cases
      x-versionadded: v2.32
    post:
      description: Look up a Use Case.
      operationId: useCases_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UseCaseCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseResponse'
          description: The experiment container.
        '422':
          description: Unprocessable Entity
      summary: Get a Use Case.
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/allResources/:
    get:
      description: Get a list of the all used assets associated with a Use Case.
      operationId: useCasesAllResources_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: '[DEPRECATED - replaced with order_by] The order to sort the
          Use Case references.'
        in: query
        name: sort
        required: true
        schema:
          default: updatedAt
          enum:
          - -entityType
          - -lastActivity
          - -name
          - -updatedAt
          - -updatedBy
          - entityType
          - lastActivity
          - name
          - updatedAt
          - updatedBy
          type: string
        x-versiondeprecated: v2.32
      - description: The order to sort the Use Case references.
        in: query
        name: orderBy
        required: true
        schema:
          default: updatedAt
          enum:
          - -entityType
          - -lastActivity
          - -name
          - -updatedAt
          - -updatedBy
          - entityType
          - lastActivity
          - name
          - updatedAt
          - updatedBy
          type: string
      - description: Only retrieve resources that had activity within the specified
          number of days.
        in: query
        name: daysSinceLastActivity
        required: false
        schema:
          exclusiveMinimum: true
          maximum: 365
          minimum: 0
          type: integer
      - description: Recipe status used for filtering recipes.
        in: query
        name: recipeStatus
        required: false
        schema:
          oneOf:
          - enum:
            - draft
            - preview
            - published
            type: string
          - items:
              enum:
              - draft
              - preview
              - published
              type: string
            type: array
        x-versionadded: v2.33
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseRecentAssetsListResponse'
          description: ''
      summary: Get a list of the references associated with all Use Cases.
      tags:
      - use_cases
      x-versionadded: v2.33
  /api/v2/useCases/notebooks/:
    get:
      description: Get a list of the notebooks from all Use Cases
      operationId: use_cases_all_notebooks
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Include use case name
        in: query
        name: includeName
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCasesNotebooksListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the notebooks from all Use Cases
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/:
    delete:
      description: Delete a Use Case.
      operationId: useCases_delete
      parameters:
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Delete a Use Case.
      tags:
      - use_cases
      x-versionadded: v2.32
    get:
      description: Retrieve a single Use Case.
      operationId: useCases_retrieve
      parameters:
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UseCaseResponse'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseResponse'
          description: ''
      summary: Get a Use Case.
      tags:
      - use_cases
      x-versionadded: v2.32
    patch:
      description: Update a Use Case.
      operationId: useCases_patch
      parameters:
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UseCaseUpdate'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseResponse'
          description: The Use Case has been successfully updated.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Use Case not found.
        '422':
          description: Unprocessable Entity
      summary: Update a Use Case.
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/applications/:
    get:
      description: Get a list of the applications associated with a Use Case
      operationId: useCasesApplications_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Only return applications with names that match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: '[DEPRECATED - replaced with order_by] The order to sort applications.'
        in: query
        name: sort
        required: true
        schema:
          default: updatedAt
          enum:
          - -applicationTemplateType
          - -createdAt
          - -lastActivity
          - -name
          - -source
          - -updatedAt
          - -userId
          - applicationTemplateType
          - createdAt
          - lastActivity
          - name
          - source
          - updatedAt
          - userId
          type: string
        x-versiondeprecated: v2.32
      - description: The order to sort applications.
        in: query
        name: orderBy
        required: true
        schema:
          default: updatedAt
          enum:
          - -applicationTemplateType
          - -createdAt
          - -lastActivity
          - -name
          - -source
          - -updatedAt
          - -userId
          - applicationTemplateType
          - createdAt
          - lastActivity
          - name
          - source
          - updatedAt
          - userId
          type: string
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCasesApplicationsListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the applications associated with a Use Case
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/data/:
    get:
      description: Get a list of the data (datasets and recipes) associated with a
        use case.
      operationId: useCasesData_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Sorting order which will be applied to data list.
        in: query
        name: orderBy
        required: true
        schema:
          default: -modifiedAt
          enum:
          - name
          - -name
          - description
          - -description
          - createdBy
          - -createdBy
          - modifiedAt
          - -modifiedAt
          - dataType
          - -dataType
          - dataSourceType
          - -dataSourceType
          - rowCount
          - -rowCount
          - columnCount
          - -columnCount
          - datasetSize
          - -datasetSize
          type: string
      - description: Only return datasets or recipes from use case with names that
          match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Data types used for filtering.
        in: query
        name: dataType
        required: false
        schema:
          oneOf:
          - enum:
            - static
            - Static
            - STATIC
            - snapshot
            - Snapshot
            - SNAPSHOT
            - dynamic
            - Dynamic
            - DYNAMIC
            - wranglingRecipe
            - WranglingRecipe
            - WRANGLING_RECIPE
            - featureDiscoveryRecipe
            - FeatureDiscoveryRecipe
            - FEATURE_DISCOVERY_RECIPE
            - dataset
            - Dataset
            - DATASET
            - recipe
            - Recipe
            - RECIPE
            type: string
          - items:
              enum:
              - static
              - Static
              - STATIC
              - snapshot
              - Snapshot
              - SNAPSHOT
              - dynamic
              - Dynamic
              - DYNAMIC
              - wranglingRecipe
              - WranglingRecipe
              - WRANGLING_RECIPE
              - featureDiscoveryRecipe
              - FeatureDiscoveryRecipe
              - FEATURE_DISCOVERY_RECIPE
              - dataset
              - Dataset
              - DATASET
              - recipe
              - Recipe
              - RECIPE
              type: string
            type: array
        x-versionadded: v2.33
      - description: The driver class type of the recipe wrangling engine.
        in: query
        name: dataSourceType
        required: false
        schema:
          oneOf:
          - enum:
            - bigquery-v1
            - databricks-v1
            - snowflake
            type: string
          - items:
              enum:
              - bigquery-v1
              - databricks-v1
              - snowflake
              type: string
            type: array
        x-versionadded: v2.33
      - description: Recipe status used for filtering recipes.
        in: query
        name: recipeStatus
        required: false
        schema:
          oneOf:
          - enum:
            - draft
            - preview
            - published
            type: string
          - items:
              enum:
              - draft
              - preview
              - published
              type: string
            type: array
        x-versionadded: v2.33
      - description: Filter results to display only those created by user(s) identified
          by the specified ID
        in: query
        name: creatorUserId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Filter results to display only those created by user(s) identified
          by the specified username
        in: query
        name: creatorUsername
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: The ID of the use case.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseDataListResponse'
          description: ''
      summary: List datasets and recipes.
      tags:
      - use_cases
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables recipe lifecycle management improvements, including manual
          and auto saving wrangling sessions, and viewing recipes for Use Case datasets
          in the Data tab.
        enabled_by_default: true
        maturity: GA_ALL
        name: UXR_RECIPES_IN_USECASE
      x-versionadded: v2.33
  /api/v2/useCases/{useCaseId}/datasets/:
    get:
      description: Get a list of the datasets associated with a Use Case
      operationId: useCasesDatasets_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: '[DEPRECATED - replaced with order_by] The order to sort the
          Use Case datasets.'
        in: query
        name: sort
        required: true
        schema:
          default: -modifiedAt
          enum:
          - -columnCount
          - -createdAt
          - -createdBy
          - -dataSourceType
          - -datasetSize
          - -datasetSourceType
          - -lastActivity
          - -modifiedAt
          - -modifiedBy
          - -name
          - -rowCount
          - columnCount
          - createdAt
          - createdBy
          - dataSourceType
          - datasetSize
          - datasetSourceType
          - lastActivity
          - modifiedAt
          - modifiedBy
          - name
          - rowCount
          type: string
        x-versiondeprecated: v2.32
      - description: The order to sort the Use Case datasets.
        in: query
        name: orderBy
        required: true
        schema:
          default: -modifiedAt
          enum:
          - -columnCount
          - -createdAt
          - -createdBy
          - -dataSourceType
          - -datasetSize
          - -datasetSourceType
          - -lastActivity
          - -modifiedAt
          - -modifiedBy
          - -name
          - -rowCount
          - columnCount
          - createdAt
          - createdBy
          - dataSourceType
          - datasetSize
          - datasetSourceType
          - lastActivity
          - modifiedAt
          - modifiedBy
          - name
          - rowCount
          type: string
      - description: Only return datasets from Use Case with names that match the
          given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseDatasetsListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the datasets associated with a Use Case
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/datasets/{datasetId}/:
    get:
      description: Retrieves the details of the dataset with given ID for given use
        case ID.
      operationId: useCasesDatasets_retrieve
      parameters:
      - description: The id linking the Use Case with the entity type.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The ID of the dataset.
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullDatasetDetailsResponse'
          description: The dataset details.
      summary: Get dataset details in the scope of use case.
      tags:
      - use_cases
      x-versionadded: v2.33
  /api/v2/useCases/{useCaseId}/filterMetadata/:
    get:
      description: Get filtering metadata information from Use Cases associated with
        a Use Case.
      operationId: useCasesFilterMetadata_list
      parameters:
      - description: The ID of the use case.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentContainerFilterMetadataRetrieveResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get filtering metadata information from Use Cases associated with a
        Use Case.
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/modelsForComparison/:
    get:
      description: 'Get a list of models from projects associated with a Use Case
        for direct comparison. NOTE: datetime partitioned models are not supported
        currently.'
      operationId: useCasesModelsForComparison_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Sort by creation date of the project associated with the model,
          default is descending order
        in: query
        name: orderBy
        required: false
        schema:
          default: -createdAt
          enum:
          - -createdAt
          - createdAt
          type: string
      - description: Binary Classification sort metric
        in: query
        name: binarySortMetric
        required: false
        schema:
          default: LogLoss
          enum:
          - AUC
          - Weighted AUC
          - Area Under PR Curve
          - Weighted Area Under PR Curve
          - Kolmogorov-Smirnov
          - Weighted Kolmogorov-Smirnov
          - FVE Binomial
          - Weighted FVE Binomial
          - Gini Norm
          - Weighted Gini Norm
          - LogLoss
          - Weighted LogLoss
          - Max MCC
          - Weighted Max MCC
          - Rate@Top5%
          - Weighted Rate@Top5%
          - Rate@Top10%
          - Weighted Rate@Top10%
          - Rate@TopTenth%
          - RMSE
          - Weighted RMSE
          type: string
      - description: Retrieve Validation, Cross-Validation, or Holdout metric scores
          for list of models, only sort by descending order (i.e. most accurate to
          least accurate)
        in: query
        name: binarySortPartition
        required: false
        schema:
          default: validation
          enum:
          - validation
          - holdout
          - crossValidation
          type: string
      - description: Regression sort metric
        in: query
        name: regressionSortMetric
        required: false
        schema:
          default: RMSE
          enum:
          - FVE Poisson
          - Weighted FVE Poisson
          - FVE Gamma
          - Weighted FVE Gamma
          - FVE Tweedie
          - Weighted FVE Tweedie
          - Gamma Deviance
          - Weighted Gamma Deviance
          - Gini Norm
          - Weighted Gini Norm
          - MAE
          - Weighted MAE
          - MAPE
          - Weighted MAPE
          - SMAPE
          - Weighted SMAPE
          - Poisson Deviance
          - Weighted Poisson Deviance
          - RMSLE
          - RMSE
          - Weighted RMSLE
          - Weighted RMSE
          - R Squared
          - Weighted R Squared
          - Tweedie Deviance
          - Weighted Tweedie Deviance
          type: string
      - description: Retrieve Validation, Cross-Validation, or Holdout metric scores
          for list of models, only sort by descending order (i.e. most accurate to
          least accurate)
        in: query
        name: regressionSortPartition
        required: false
        schema:
          default: validation
          enum:
          - validation
          - holdout
          - crossValidation
          type: string
      - description: Filter to limited number of top scoring models, where default
          value is 1. A value of 0 means no top scoring models will be returned.
        in: query
        name: numberTopModels
        required: false
        schema:
          default: 1
          maximum: 10
          minimum: 0
          type: integer
      - description: Filter to models trained at the specified sample size percentage(s)
        in: query
        name: samplePct
        required: false
        schema:
          oneOf:
          - exclusiveMinimum: true
            maximum: 100
            minimum: 0
            type: number
          - items:
              exclusiveMinimum: true
              maximum: 100
              minimum: 0
              type: number
            type: array
      - description: Filter to models that match the specified model family/families
        in: query
        name: modelFamily
        required: false
        schema:
          oneOf:
          - enum:
            - AB
            - AD
            - BLENDER
            - CAL
            - CLUSTER
            - COUNT_DICT
            - CUSTOM
            - DOCUMENT
            - DT
            - DUMMY
            - EP
            - EQ
            - EQ_TS
            - FM
            - GAM
            - GBM
            - GLM
            - GLMNET
            - IMAGE
            - KNN
            - NB
            - NN
            - OTHER
            - RF
            - RI
            - SEGMENTED
            - SVM
            - TEXT
            - TS
            - TS_NN
            - TTS
            - VW
            type: string
          - items:
              enum:
              - AB
              - AD
              - BLENDER
              - CAL
              - CLUSTER
              - COUNT_DICT
              - CUSTOM
              - DOCUMENT
              - DT
              - DUMMY
              - EP
              - EQ
              - EQ_TS
              - FM
              - GAM
              - GBM
              - GLM
              - GLMNET
              - IMAGE
              - KNN
              - NB
              - NN
              - OTHER
              - RF
              - RI
              - SEGMENTED
              - SVM
              - TEXT
              - TS
              - TS_NN
              - TTS
              - VW
              type: string
            type: array
      - description: Whether to include all starred models in filtering output. This
          means starred models will be included in addition to top-scoring models.
        in: query
        name: includeAllStarredModels
        required: false
        schema:
          type: boolean
      - description: Filter to models from projects built using specified training
          dataset ID(s)
        in: query
        name: trainingDatasetId
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Filter to models from projects built using specified target feature(s)
        in: query
        name: targetFeature
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
      - description: Whether to include only models that can be converted to scorable
          java code
        in: query
        name: scoringCodeOnly
        required: false
        schema:
          type: boolean
      - description: The ID of the use case.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseModelsForComparisonListResponse'
          description: ''
        '400':
          description: Bad request
        '403':
          description: User does not have access to this functionality.
        '422':
          description: Unable to retrieve models for the Use Case.
      summary: Get a list of models from projects associated with a Use Case for direct
        comparison
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/multilink/:
    post:
      description: Link multiple entities to a Use Case.
      operationId: useCasesMultilink_create
      parameters:
      - description: The ID of the use case.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UseCaseReferenceMultilink'
      responses:
        '200':
          description: ''
      summary: Link multiple entities to a Use Case.
      tags:
      - use_cases
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables asset migration from DataRobot Classic to DataRobot NextGen.
        enabled_by_default: false
        maturity: PUBLIC_PREVIEW
        name: NEXTGEN_ASSET_MIGRATION
  /api/v2/useCases/{useCaseId}/notebooks/:
    get:
      description: Get a list of the notebooks associated with a Use Case
      operationId: useCasesNotebooks_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCasesNotebooksListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the notebooks associated with a Use Case
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/playgrounds/:
    get:
      description: Get a list of the playgrounds associated with a Use Case
      operationId: useCasesPlaygrounds_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCasesPlaygroundsListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the playgrounds associated with a Use Case
      tags:
      - use_cases
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the creation, management, and utilization of a vector
          database-augmented LLM solution, allowing organizations to use their content
          to experiment and leverage GenAI for a specific use case.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: GENAI_EXPERIMENTATION
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/projects/:
    get:
      description: Get a list of the projects associated with a Use Case.
      operationId: useCasesProjects_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Only return Use Cases with names that match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: '[DEPRECATED - replaced with order_by] The order to sort the
          Use Case projects.'
        in: query
        name: sort
        required: true
        schema:
          default: updatedAt
          enum:
          - -createdAt
          - -createdBy
          - -dataset
          - -featureCount
          - -fullName
          - -lastActivity
          - -models
          - -name
          - -projectId
          - -rowCount
          - -target
          - -targetType
          - -timeAware
          - -updatedAt
          - -updatedBy
          - createdAt
          - createdBy
          - dataset
          - featureCount
          - fullName
          - lastActivity
          - models
          - name
          - projectId
          - rowCount
          - target
          - targetType
          - timeAware
          - updatedAt
          - updatedBy
          type: string
        x-versiondeprecated: v2.32
      - description: The order to sort the Use Case projects.
        in: query
        name: orderBy
        required: true
        schema:
          default: updatedAt
          enum:
          - -createdAt
          - -createdBy
          - -dataset
          - -featureCount
          - -fullName
          - -lastActivity
          - -models
          - -name
          - -projectId
          - -rowCount
          - -target
          - -targetType
          - -timeAware
          - -updatedAt
          - -updatedBy
          - createdAt
          - createdBy
          - dataset
          - featureCount
          - fullName
          - lastActivity
          - models
          - name
          - projectId
          - rowCount
          - target
          - targetType
          - timeAware
          - updatedAt
          - updatedBy
          type: string
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseProjectsListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the projects associated with a Use Case.
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/resources/:
    get:
      description: Get a list of the references associated with a use case
      operationId: useCasesResources_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: '[DEPRECATED - replaced with order_by] The order to sort the
          Use Case references.'
        in: query
        name: sort
        required: true
        schema:
          default: updatedAt
          enum:
          - -entityType
          - -lastActivity
          - -name
          - -updatedAt
          - -updatedBy
          - entityType
          - lastActivity
          - name
          - updatedAt
          - updatedBy
          type: string
        x-versiondeprecated: v2.32
      - description: The order to sort the Use Case references.
        in: query
        name: orderBy
        required: true
        schema:
          default: updatedAt
          enum:
          - -entityType
          - -lastActivity
          - -name
          - -updatedAt
          - -updatedBy
          - entityType
          - lastActivity
          - name
          - updatedAt
          - updatedBy
          type: string
      - description: Only retrieve resources that had activity within the specified
          number of days.
        in: query
        name: daysSinceLastActivity
        required: false
        schema:
          exclusiveMinimum: true
          maximum: 365
          minimum: 0
          type: integer
      - description: Recipe status used for filtering recipes.
        in: query
        name: recipeStatus
        required: false
        schema:
          oneOf:
          - enum:
            - draft
            - preview
            - published
            type: string
          - items:
              enum:
              - draft
              - preview
              - published
              type: string
            type: array
        x-versionadded: v2.33
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseReferenceListResponse'
          description: ''
      summary: Get a list of the references associated with a use case
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/sharedRoles/:
    get:
      description: Get a list of users who have access to this Use Case and their
        roles on the Use Case.
      operationId: useCasesSharedRoles_list
      parameters:
      - description: The number of records to skip over.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Optional, only return the access control information for a user
          with this user ID.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRolesWithGrantListResponse'
          description: ''
        '404':
          description: Either the Use Case does not exist or the user does not have
            permissions to view the data store.
        '422':
          description: Both username and userId were specified
      summary: Get Use Case's access control list.
      tags:
      - use_cases
      x-versionadded: v2.32
    patch:
      description: Update the list of users who have access to this Use Case and their
        roles on the Use Case.
      operationId: useCasesSharedRoles_patchMany
      parameters:
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperimentContainerSharedRolesUpdate'
      responses:
        '200':
          description: ''
      summary: Update a Use Case's access control list.
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/vectorDatabases/:
    get:
      description: Get a list of the vector databases associated with a Use Case
      operationId: useCasesVectorDatabases_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The ID of the Use Case to update.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCasesVectorDatabasesListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get a list of the vector databases associated with a Use Case
      tags:
      - use_cases
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the creation, management, and utilization of a vector
          database-augmented LLM solution, allowing organizations to use their content
          to experiment and leverage GenAI for a specific use case.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: GENAI_EXPERIMENTATION
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/{referenceCollectionType}/{entityId}/:
    delete:
      description: Remove a related entity from a use case.
      operationId: useCases_reference_delete
      parameters:
      - description: If True, delete the linked resource
        in: query
        name: deleteResource
        required: true
        schema:
          default: false
          type: boolean
      - description: The id linking the Use Case with the entity type.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The reference collection type.
        in: path
        name: referenceCollectionType
        required: true
        schema:
          enum:
          - projects
          - datasets
          - notebooks
          - applications
          - recipes
          type: string
      - description: The primary id of the entity.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '204':
          description: The relationship has been removed successfully
        '404':
          description: Use Case reference not found
      summary: Remove a related entity from a use case.
      tags:
      - use_cases
      x-versionadded: v2.32
    patch:
      description: Move entity from one Use Case to another.
      operationId: useCases_reference_move
      parameters:
      - description: The id linking the Use Case with the entity type.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The reference collection type.
        in: path
        name: referenceCollectionType
        required: true
        schema:
          enum:
          - projects
          - datasets
          - notebooks
          - applications
          - recipes
          type: string
      - description: The primary id of the entity.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Move entity from one Use Case to another.
      tags:
      - use_cases
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables asset migration from DataRobot Classic to DataRobot NextGen.
        enabled_by_default: false
        maturity: PUBLIC_PREVIEW
        name: NEXTGEN_ASSET_MIGRATION
    post:
      description: Link entity to a single Use Case.
      operationId: useCases_createOne
      parameters:
      - description: The id linking the Use Case with the entity type.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The reference collection type.
        in: path
        name: referenceCollectionType
        required: true
        schema:
          enum:
          - projects
          - datasets
          - notebooks
          - applications
          - recipes
          type: string
      - description: The primary id of the entity.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UseCaseReferenceLink'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentContainerReferenceRetrieve'
          description: ''
        '201':
          description: The entity has been linked successfully
        '403':
          description: User does not have access to this functionality.
        '409':
          description: The entity has already been linked
        '422':
          description: Unprocessable Entity
      summary: Link entity to a Use Case
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/userBlueprints/:
    delete:
      description: Delete user blueprints, specified by `userBlueprintIds`.
      operationId: userBlueprints_deleteMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintsBulkDelete'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsBulkDeleteResponse'
          description: A list of user blueprints successfully and unsuccessfully deleted.
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '422':
          description: Unprocessable Entity
      summary: Delete user blueprints.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.28
    get:
      description: Fetch a list of the user blueprints the current user has access
        to
      operationId: userBlueprints_list
      parameters:
      - description: The number of results to skip (for pagination).
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The max number of results to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          minimum: 0
          type: integer
      - description: The id of the project, used to filter for original project_id.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsListResponse'
          description: Fetched the list of the accessible user blueprints successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
      summary: List user blueprints.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
    post:
      description: Create a user blueprint
      operationId: userBlueprints_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsDetailedItem'
          description: Created the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Project not found.
        '422':
          description: Unprocessable Entity
      summary: Create a user blueprint.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprints/fromBlueprintId/:
    post:
      description: Clone a blueprint from a project.
      operationId: userBlueprintsFromBlueprintId_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintCreateFromBlueprintId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsDetailedItem'
          description: Created the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Project or blueprint not found.
        '422':
          description: Unprocessable Entity
      summary: Clone a blueprint from a project.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprints/fromCustomTaskVersionId/:
    post:
      description: Create a user blueprint from a single custom task.
      operationId: userBlueprintsFromCustomTaskVersionId_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintCreateFromCustomTaskVersionIdPayload'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsDetailedItem'
          description: Created the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Custom task version or custom task not found.
        '422':
          description: Unprocessable Entity
      summary: Create a user blueprint from a single custom task.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprints/fromUserBlueprintId/:
    post:
      description: Clone a user blueprint.
      operationId: userBlueprintsFromUserBlueprintId_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintCreateFromUserBlueprintId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsDetailedItem'
          description: Created the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: User blueprint or project not found.
        '422':
          description: Unprocessable Entity
      summary: Clone a user blueprint.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprints/{userBlueprintId}/:
    delete:
      description: Delete a user blueprint, specified by the `userBlueprintId`.
      operationId: userBlueprints_delete
      parameters:
      - description: Used to identify a specific user-owned blueprint.
        in: path
        name: userBlueprintId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted the specified blueprint, if it existed.
      summary: Delete a user blueprint.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
    get:
      description: Retrieve a user blueprint
      operationId: userBlueprints_retrieve
      parameters:
      - description: Whether to retrieve the extra blueprint metadata for editing.
        in: query
        name: editMode
        required: true
        schema:
          default: false
          type: boolean
      - description: Whether to retrieve the blueprint in the decompressed format.
        in: query
        name: decompressedBlueprint
        required: true
        schema:
          default: false
          type: boolean
      - description: String representation of ObjectId for the currently active project.
          The user blueprint is retrieved when this project is active.
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: Whether the request is sent from the in place user BP editor.
        in: query
        name: isInplaceEditor
        required: true
        schema:
          default: false
          type: boolean
      - description: Whether to add dynamic labels to a decompressed blueprint.
        in: query
        name: getDynamicLabels
        required: false
        schema:
          default: false
          type: boolean
      - description: Used to identify a specific user-owned blueprint.
        in: path
        name: userBlueprintId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsRetrieveResponse'
          description: Retrieved the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Referenced project or user blueprint not found.
      summary: Retrieve a user blueprint.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
    patch:
      description: Update a user blueprint
      operationId: userBlueprints_patch
      parameters:
      - description: Used to identify a specific user-owned blueprint.
        in: path
        name: userBlueprintId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsDetailedItem'
          description: Updated the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: User blueprint not found.
        '422':
          description: Unprocessable Entity
      summary: Update a user blueprint.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprints/{userBlueprintId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations that have an access
        to this user blueprint
      operationId: userBlueprintsSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: Used to identify a specific user-owned blueprint.
        in: path
        name: userBlueprintId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintSharedRolesListResponse'
          description: Successfully retrieved roles.
      summary: Get a list of users, groups and organizations that have an access to
        this user blueprint
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
    patch:
      description: Share a user blueprint with a user, group, or organization
      operationId: userBlueprintsSharedRoles_patchMany
      parameters:
      - description: Used to identify a specific user-owned blueprint.
        in: path
        name: userBlueprintId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: Roles updated successfully
        '400':
          description: Bad Request
        '403':
          description: User can view entity but does not have permission to grant
            these roles on the entity.
        '404':
          description: Either the entity does not exist or the user does not have
            permissions to view the entity.
        '409':
          description: The request would leave the entity without an owner.
        '422':
          description: The request was formatted improperly.
      summary: Share a user blueprint with a user, group, or organization
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprintsBulkValidations/:
    post:
      description: Validate many user blueprints, optionally using a specific project.
        Any non-existent or inaccessible user blueprints will be ignored.
      operationId: userBlueprintsBulkValidations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintBulkValidationRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsBulkValidationResponse'
          description: Validated many user blueprints successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Referenced project was not found.
        '422':
          description: Unprocessable Entity
      summary: Validate many user blueprints.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprintsInputTypes/:
    get:
      description: Retrieve the input types which can be used with User Blueprints.
      operationId: userBlueprintsInputTypes_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsInputTypesResponse'
          description: Successfully retrieved the input types.
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
      summary: Retrieve input types.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprintsProjectBlueprints/:
    post:
      description: Add a list of user blueprints, by id, to a specified (by id) project's
        repository.
      operationId: userBlueprintsProjectBlueprints_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintAddToMenu'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintAddToMenuResponse'
          description: Successfully added the user blueprints to the project's repository.
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Referenced project not found.
        '422':
          description: Unprocessable Entity
      summary: Add user blueprints to a project.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprintsTaskParameters/:
    post:
      description: Validate that each value assigned to specified task parameters
        are valid.
      operationId: userBlueprintsTaskParameters_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintTaskParameterValidation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsValidateTaskParametersResponse'
          description: Accepted validation parameters for a task in the context of
            User Blueprints.
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Custom task version not found
        '422':
          description: Unprocessable Entity
      summary: Validate task parameters.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprintsTasks/:
    get:
      description: Retrieve the available tasks, organized into categories, which
        can be used to create or modify User Blueprints.
      operationId: userBlueprintsTasks_list
      parameters:
      - description: The project id to use for task retrieval
        in: query
        name: projectId
        required: false
        schema:
          type: string
      - description: The blueprint id to use for task retrieval
        in: query
        name: blueprintId
        required: false
        schema:
          type: string
      - description: The user blueprint id to use for task retrieval
        in: query
        name: userBlueprintId
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintTasksResponse'
          description: Successfully retrieved the tasks.
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Referenced project or user blueprint not found.
      summary: Retrieve tasks for blueprint construction.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userBlueprintsValidations/:
    post:
      description: Validate a user blueprint
      operationId: userBlueprintsValidations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBlueprintValidation'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserBlueprintsValidationResponse'
          description: Validated the user blueprint successfully
        '401':
          description: User is not authorized.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Referenced project not found.
        '422':
          description: Unprocessable Entity
      summary: Validate a user blueprint.
      tags:
      - blueprints
      - ai_catalog
      x-versionadded: v2.27
  /api/v2/userCleanupJobs/:
    post:
      description: Schedules a job which permanently delete the users represented
        by the provided users ids or organization id. Number of users to be deleted
        in one go is restricted by DELETED_USERS_BATCH_LIMIT system setting.
      operationId: userCleanupJobs_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsersPermadelete'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeleteJobResponse'
          description: The users delete job status link.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '409':
          description: Self deletion or some users are already under deletion.
        '422':
          description: Invalid data
        '500':
          description: Failed to schedule users perma-delete job.
      summary: Users permanent delete.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupJobs/{statusId}/:
    delete:
      description: Cancel permanent deletion of the selected users.
      operationId: userCleanupJobs_delete
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '422':
          description: Invalid data
      summary: Cancel users perma-deletion.
      tags:
      - user_management
      x-versionadded: v2.26
    get:
      description: Get async status of the users perma-delete job.
      operationId: userCleanupJobs_retrieve
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeleteJobStatusResponse'
          description: Users perma-delete job status.
      summary: Retrieve users perma-delete job status.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupPreviewJobs/:
    post:
      description: Schedules a job for building preview for users selected for permanent
        deletion. Number of users to be deleted in one go is restricted by DELETED_USERS_BATCH_LIMIT
        system setting.
      operationId: userCleanupPreviewJobs_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsersPermadelete'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeletePreviewJobResponse'
          description: The users delete preview job status link.
          headers:
            Location:
              description: A url that can be polled to check the status.
              schema:
                type: string
        '409':
          description: Self deletion or some users are already under deletion.
        '422':
          description: Invalid data
        '500':
          description: Failed to schedule perma-delete preview building job.
      summary: Users permanent delete preview.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupPreviewJobs/{statusId}/:
    delete:
      description: Cancel scheduled users permanent delete preview building.
      operationId: userCleanupPreviewJobs_delete
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '422':
          description: Invalid data
      summary: Cancel users perma-delete preview building.
      tags:
      - user_management
      x-versionadded: v2.26
    get:
      description: Get async status of the users perma-delete preview building job.
      operationId: userCleanupPreviewJobs_retrieve
      parameters:
      - description: The ID of the status object.
        in: path
        name: statusId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeletePreviewJobStatusResponse'
          description: Perma-delete preview job status.
      summary: Retrieve users perma-delete preview job status.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupPreviews/{reportId}/:
    delete:
      description: Delete users permanent delete report.
      operationId: userCleanupPreviews_delete
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Report is deleted.
        '422':
          description: Invalid data
      summary: Delete users permanent delete report.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupPreviews/{reportId}/content/:
    get:
      description: Retrieve users permanent delete extended preview.
      operationId: userCleanupPreviewsContent_list
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The users delete extended preview file.
          headers:
            Content-Disposition:
              description: attachment; filename="<"filename">".json JSON file with
                users delete extended preview.
              schema:
                type: string
            Content-Type:
              description: application/json
              schema:
                format: binary
                type: string
        '422':
          description: Invalid data
      summary: Users permanent delete extended preview.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupPreviews/{reportId}/deleteParams/:
    get:
      description: Retrieve users permanent delete report parameters.
      operationId: userCleanupPreviewsDeleteParams_list
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeleteDeleteReportParamsResponse'
          description: The users delete report parameters.
        '422':
          description: Invalid data
      summary: Users permanent delete report parameters.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupPreviews/{reportId}/statistics/:
    get:
      description: Retrieve users permanent delete preview statistics.
      operationId: userCleanupPreviewsStatistics_list
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeletePreviewStatisticsResponse'
          description: The users delete preview statistics.
        '422':
          description: Invalid data
      summary: Users permanent delete preview statistics.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupSummaries/{reportId}/:
    delete:
      description: Delete users permanent delete report.
      operationId: userCleanupSummaries_delete
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Report is deleted.
        '422':
          description: Invalid data
      summary: Delete users permanent delete report.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupSummaries/{reportId}/content/:
    get:
      description: Retrieve users permanent delete extended summary.
      operationId: userCleanupSummariesContent_list
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The users delete extended summary file.
          headers:
            Content-Disposition:
              description: attachment; filename="<"filename">".json JSON file with
                with users delete extended summary.
              schema:
                type: string
            Content-Type:
              description: application/json
              schema:
                format: binary
                type: string
        '422':
          description: Invalid data
      summary: Users permanent delete extended summary.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupSummaries/{reportId}/deleteParams/:
    get:
      description: Retrieve users permanent delete report parameters.
      operationId: userCleanupSummariesDeleteParams_list
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeleteDeleteReportParamsResponse'
          description: The users delete report parameters.
        '422':
          description: Invalid data
      summary: Users permanent delete report parameters.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userCleanupSummaries/{reportId}/statistics/:
    get:
      description: Retrieve users permanent delete summary statistics.
      operationId: userCleanupSummariesStatistics_list
      parameters:
      - description: Report ID
        in: path
        name: reportId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersPermadeleteSummaryReportStatisticsResponse'
          description: The users delete summary statistics.
        '422':
          description: Invalid data
      summary: Users permanent delete summary statistics.
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userNotifications/:
    delete:
      description: Delete all notifications associated with the user.
      operationId: userNotifications_deleteMany
      responses:
        '204':
          description: Notifications were deleted.
      summary: Delete all user notifications
      tags:
      - notifications
      x-versionadded: v2.23
    get:
      description: Returns list of user's notifications from latest to oldest.
      operationId: userNotifications_list
      parameters:
      - description: The number of records to skip over
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: When provided, returns only read or unread notifications
        in: query
        name: isRead
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserNotificationListResponse'
          description: A paginated list of notifications.
      summary: List user notifications
      tags:
      - notifications
      x-versionadded: v2.23
    patch:
      description: Mark all associated notifications with the user as read.
      operationId: userNotifications_patchMany
      responses:
        '204':
          description: All notification were marked as read.
      summary: Mark all as read
      tags:
      - notifications
      x-versionadded: v2.23
  /api/v2/userNotifications/{userNotificationId}/:
    delete:
      description: Delete one notification associated with the user.
      operationId: userNotifications_delete
      parameters:
      - description: Unique identifier of the notification.
        in: path
        name: userNotificationId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Notification was deleted.
      summary: Delete user notification
      tags:
      - notifications
      x-versionadded: v2.23
    patch:
      description: Mark one associated notification with the user as read.
      operationId: userNotifications_patch
      parameters:
      - description: Unique identifier of the notification.
        in: path
        name: userNotificationId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Notification was marked as read.
      summary: Mark as read
      tags:
      - notifications
      x-versionadded: v2.23
  /api/v2/users/:
    get:
      description: Retrieve a list of existing users.
      operationId: users_list
      parameters:
      - description: Number of results to skip.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned. The default may change
          without notice.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 1000
          minimum: 0
          type: integer
      - description: When present, only return users with names that contain the given
          substring.
        in: query
        name: namePart
        required: false
        schema:
          default: ''
          type: string
      - description: Email address of the user.
        in: query
        name: username
        required: false
        schema:
          default: ''
          type: string
      - description: Datetime, RFC3339.
        in: query
        name: expirationDateLte
        required: false
        schema:
          format: date-time
          type: string
      - description: Boolean return activated or deactivated users
        in: query
        name: activated
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Sort order to apply when listing users.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - registeredOn
          - -registeredOn
          - updatedAt
          - -updatedAt
          type: string
      - description: Query users scoped to the tenant
        in: query
        name: tenantId
        required: false
        schema:
          type: string
      - description: User ID in external marketing systems (SFDC)
        in: query
        name: attributionId
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Count of users returned, next/previous page URLs, and array
            'data' of user objects.
        '403':
          description: forbidden for non-administrators.
      summary: Retrieve a list of existing users.
      tags:
      - user_management
      x-versionadded: v2.32
    post:
      description: Create a User and add them to an organization.
      operationId: users_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCreateResponse'
          description: The username and userId of the newly created user.
        '409':
          description: User already exists.
        '422':
          description: Password invalid/required.
      summary: Create a User and add them to an organization.
      tags:
      - user_management
      x-versionadded: v2.19
  /api/v2/users/{userId}/:
    get:
      description: Retrieve a single user by id.
      operationId: users_retrieve
      parameters:
      - description: The user identifier.
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Info of requested user.
        '403':
          description: Forbidden for non-administrators.
        '404':
          description: User not found.
      summary: Retrieve a single user by id.
      tags:
      - user_management
      x-versionadded: v2.32
  /api/v2/users/{userId}/rateLimitUsage/:
    delete:
      description: Reset specified user's rate limit resource usage to zero for all
        resources. When windows roll over, all limits are automatically reset. Use
        this route to reset usage sooner.
      operationId: usersRateLimitUsage_deleteMany
      parameters:
      - description: The user identifier.
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The usage has been successfully reset to zero.
      summary: Reset resource usage for all resources
      tags:
      - analytics
      x-versionadded: v2.0
    get:
      description: List the rate limit resource usage for a user. The usage array
        returned will have one object corresponding to each rate limit applied to
        the user.
      operationId: usersRateLimitUsage_list
      parameters:
      - description: The user identifier.
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUsageResponse'
          description: ''
      summary: List resource usage for a user
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/users/{userId}/rateLimitUsage/{resourceName}/:
    delete:
      description: Reset rate limit resource usage for a user of a specified resource
        to zero. This will happen automatically when windows roll over. This route
        can be used to reset a user's rate limits sooner.
      operationId: usersRateLimitUsage_delete
      parameters:
      - description: The id of the user to reset usage for.
        in: path
        name: userId
        required: true
        schema:
          type: string
      - description: The resource name to reset usage for.
        in: path
        name: resourceName
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The usage has been successfully reset to zero.
      summary: Reset resource usage for the resource
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/valueTrackerValueTemplates/:
    get:
      description: List available value trackers templates.
      operationId: valueTrackerValueTemplates_list
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ValueTrackerValueTemplateResponse'
                type: array
          description: ''
      summary: List available value trackers templates.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackerValueTemplates/{templateType}/:
    get:
      description: Get an individual value tracker value template by its name.
      operationId: valueTrackerValueTemplates_retrieve
      parameters:
      - description: The name of the class ValueTracker value template to be retrieved
        in: path
        name: templateType
        required: true
        schema:
          enum:
          - classification
          - regression
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerValueTemplateResponse'
          description: ''
        '400':
          description: Bad request
      summary: Get an individual value tracker value template by its name.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackerValueTemplates/{templateType}/calculation/:
    get:
      description: Calculate value of template with given template parameters.
      operationId: valueTrackerValueTemplatesCalculation_list
      parameters:
      - description: Accuracy improvement
        in: query
        name: accuracyImprovement
        required: true
        schema:
          type: number
      - description: Estimated number of decisions per year
        in: query
        name: decisionsCount
        required: true
        schema:
          type: integer
      - description: Estimated number of incorrect decisions per year. Required for
          templateType CLASSIFICATION
        in: query
        name: incorrectDecisionsCount
        required: false
        schema:
          type: integer
      - description: Estimated cost of an individual incorrect decision. Required
          for templateType CLASSIFICATION
        in: query
        name: incorrectDecisionCost
        required: false
        schema:
          type: number
      - description: Target value. Required for templateType REGRESSION
        in: query
        name: targetValue
        required: false
        schema:
          type: number
      - description: The name of the class ValueTracker value template to be retrieved
        in: path
        name: templateType
        required: true
        schema:
          enum:
          - classification
          - regression
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerValueTemplateCalculateResponse'
          description: ''
        '400':
          description: Bad request
      summary: Calculate value of template with given template parameters.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/:
    get:
      description: List value trackers the requesting user has access to.
      operationId: valueTrackers_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: Sort the class ValueTrackers by a field of the class ValueTracker.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - businessImpact
          - -businessImpact
          - potentialValue
          - -potentialValue
          - realizedValue
          - -realizedValue
          - feasibility
          - -feasibility
          - stage
          - -stage
          type: string
      - description: Only return class ValueTrackers with names that match the given
          string.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: Filter results by the current stage of the class ValueTrackers.
        in: query
        name: stage
        required: false
        schema:
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerListResponse'
          description: ''
      summary: List value trackers the requesting user has access to.
      tags:
      - value_tracker
      x-versionadded: v2.31
    post:
      description: Create a new value tracker.
      operationId: valueTrackers_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueTracker'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerCreateResponse'
          description: ''
      summary: Create a new value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/:
    delete:
      description: Delete a value tracker
      operationId: valueTrackers_delete
      parameters:
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '204':
          description: The value tracker was deleted
      summary: Delete a value tracker
      tags:
      - value_tracker
      x-versionadded: v2.31
    get:
      description: Retrieve a value tracker.
      operationId: valueTrackers_retrieve
      parameters:
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerResponse'
          description: ''
      summary: Retrieve a value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
    patch:
      description: Update a value tracker.
      operationId: valueTrackers_patch
      parameters:
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueTrackerUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerResponse'
          description: ''
      summary: Update a value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/activities/:
    get:
      description: Retrieve the activities of a value tracker.
      operationId: valueTrackersActivities_list
      parameters:
      - description: The number of records to skip over. Default 0.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of records to return in the range from 1 to 100. Default
          100.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerActivityListResponse'
          description: ''
      summary: Retrieve the activities of a value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/attachments/:
    get:
      description: Get a list of resources attached to this value tracker.
      operationId: valueTrackersAttachments_list
      parameters:
      - description: This many results will be skipped
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: This many results are returned
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: true
          maximum: 100
          minimum: 0
          type: integer
      - description: class ValueTracker attachment type
        in: query
        name: type
        required: false
        schema:
          enum:
          - dataset
          - modelingProject
          - deployment
          - customModel
          - modelPackage
          - application
          type: string
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerAttachmentListResponse'
          description: ''
        '404':
          description: Either the value tracker does not exist or the user does not
            have permissions to view this value tracker.
      summary: Get a list of resources attached to this value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
    post:
      description: Attach a list of resources to this value tracker.
      operationId: valueTrackersAttachments_create
      parameters:
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateValueTrackerAttachment'
      responses:
        '201':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ValueTrackerAttachment'
                type: array
          description: ''
        '404':
          description: Use case or object not found or value tracker not writable
            or object not readable.
        '422':
          description: The request was formatted improperly
      summary: Attach a list of resources to this value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/attachments/{attachmentId}/:
    delete:
      description: Removes a resource from a value tracker.
      operationId: valueTrackersAttachments_delete
      parameters:
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      - description: The id of the attachment
        in: path
        name: attachmentId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: The user does not have permission to remove objects from this
            value tracker
        '404':
          description: Either the value tracker does not exist or the user does not
            have permissions to view this value tracker.
        '422':
          description: The request was formatted improperly, or the requested object
            to delete was not found
      summary: Removes a resource from a value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
    get:
      description: Get a resource that is attached to a value tracker.
      operationId: valueTrackersAttachments_retrieve
      parameters:
      - description: The id of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      - description: The id of the attachment
        in: path
        name: attachmentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerAttachmentResponse'
          description: ''
        '403':
          description: The user does not have permission to attach objects to this
            value tracker
        '404':
          description: Either the value tracker does not exist or the user does not
            have permissions to view this value tracker.
        '422':
          description: The request was formatted improperly, or the requested object
            to attach was not found
      summary: Get a resource that is attached to a value tracker.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/realizedValueOverTime/:
    get:
      description: Retrieve realized value information for a given value tracker over
        a period of time
      operationId: valueTrackersRealizedValueOverTime_list
      parameters:
      - description: 'Start of the period to retrieve monitoring data, defaults to
          7 days ago from the end of the period. Note: this field only accepts top
          of the hour RFC3339 datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: start
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: 'End of the period to retrieve monitoring data, defaults to the
          next top of the hour. Note: this field only accepts top of the hour RFC3339
          datetime strings, for example: ``2019-08-01T00:00:00Z``.'
        in: query
        name: end
        required: false
        schema:
          format: date-time
          nullable: true
          type: string
      - description: The time duration of a bucket. Needs to be multiple of one hour.
          Can not be longer than the total length of the period. If not set, a default
          value will be calculated based on the start and end time.
        in: query
        name: bucketSize
        required: false
        schema:
          format: duration
          type: string
      - description: The ID of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerRealizedValuesOverTimeResponse'
          description: ''
      summary: Retrieve realized value information for a given value tracker over
        a period of time
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations that have an access
        to this value tracker
      operationId: valueTrackersSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this
          identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this
          name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: List access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          type: string
      - description: The ID of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueTrackerSharingListResponse'
          description: ''
      summary: Get a list of users, groups and organizations that have an access to
        this value tracker
      tags:
      - value_tracker
      x-versionadded: v2.31
    patch:
      description: Share a value tracker with a user, group or organization.
      operationId: valueTrackersSharedRoles_patchMany
      parameters:
      - description: The ID of the class ValueTracker
        in: path
        name: valueTrackerId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueTrackerSharingUpdate'
      responses:
        '200':
          description: ''
        '204':
          description: The roles updated successfully
        '422':
          description: The request was formatted improperly
      summary: Share a value tracker with a user, group or organization.
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/version/:
    get:
      description: Provides the version information for the current version of the
        API.
      operationId: version_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionRetrieveResponse'
          description: ''
      summary: Retrieve version information.
      tags:
      - infrastructure
      x-versionadded: v2.4
security:
- BearerAuth: []
servers:
- url: /
tags:
- description: Read below to learn about DataRobot's endpoints for managing data,
    including topics such as the AI Catalog, datasets, feature lists, and blueprints.
    Reference the [Glossary](glossary/index) and UI documentation for more information
    about these topics.
  name: ai_catalog
- description: Use analytics endpoints to retrieve and audit and event logs.
  name: analytics
- description: Read below to learn about DataRobot's endpoints for applications. Reference
    the [AI App Builder](app-builder/index) documentation for more information.
  name: applications
- description: This page outlines DataRobot's endpoints for blueprints, a graphical
    representation of the many steps involved in transforming input predictors and
    targets into a model.
  name: blueprints
- description: The following endpoints outline how to add comments and host discussion
    for a model.
  name: comments
- description: The following endpoints outline how to manage user credentials.
  name: credentials
- description: Assemble, test and deploy your own custom model with a custom environment.
  name: custom_models
- description: Create and apply custom tasks and use them to create blueprints.
  name: custom_tasks
- description: This page outlines how to integrate with a variety of enterprise databases,
    using a 'self-service' JDBC platform.
  name: data_connectivity
- description: This page outlines the operations and endpoints for data wrangling
    (preparation).
  name: data_wrangling
- description: This page outlines how to organize partitioning for model events that
    take place over time.
  name: datetime_partitioning
- description: This page outlines the operations, endpoints, parameters, and example
    requests and responses for the decisions.
  name: decisions
- description: This page outlines how to bring models to production by following the
    workflows provided for all kinds of starting artifacts.
  name: deployments
- description: Use the following endpoints to retrieve blueprints and their associated
    documentation.
  name: documentation
- description: Use the endpoints described below to interact with document specific
    features.
  name: documents
- description: This page describes the endpoints for enacting workflow requirements
    to ensure quality and comply with regulatory obligations.
  name: governance
- description: Use the endpoints described below to assemble augmentation lists and
    manage images for projects.
  name: images
- description: Use the endpoints described below to manage cluster licenses.
  name: infrastructure
- description: Use the endpoints described below to generate and interpret insights
    for specific models.
  name: insights
- description: This page outlines the endpoints that create and manage DataRobot model
    evaluation jobs.
  name: jobs
- description: This page outlines the endpoints that manage large language model playgrounds
    and vector databases.
  name: large_language_models
- description: This page outlines the capabilities of MLOps, DataRobot's hub for deploying
    and monitoring ML models in production.
  name: mlops
- description: Use the endpoints described below to create and manage DataRobot models.
  name: models
- description: This page outlines DataRobot's endpoints for Jupyter notebooks.
  name: notebooks
- description: This page outlines how to manage notifications received by users.
  name: notifications
- description: Use the endpoints described below to generate predictions for a project.
  name: predictions
- description: Use the endpoints described below to manage projects and their properties.
  name: projects
- description: Start Livy and Spark application inside a container.
  name: spark_application
- description: Use the endpoints described below to configure single sign-on for your
    organization.
  name: sso_configuration
- description: Use the endpoints described below to retrieve information about backend
    system services powering datarobots, eg. Postgres, Mongodb.
  name: system_service
- description: This page describes the endpoints for handling users, groups, and organizations.
  name: user_management
- description: This page outlines the operations, endpoints, parameters, and example
    requests and responses for the Value Trackers.
  name: value_tracker
- description: Use the endpoints described below to configure and manage encrypted
    credentials.
  name: utilities
- description: Use the endpoints described below to configure and manage Secure Configuration
    objects. This abstraction allows system and organization administrations to securely
    store and manage credentials. Users with lesser permissions can have the credentials
    shared with them, but be unable to view or edit their contents.
  name: secure_config
- description: The endpoints below outline how to create and manage Workbench Use
    Cases. They are not associated with the Value Tracker, which was formerly called
    Use Cases.
  name: use_cases
- description: These endpoints described to retrieve information required for the
    homepage. (e.g. workspaces resources conters)
  name: homepage
- description: The endpoints below outline how to create and manage data chunks, load
    data from a remote SQL source and split it into a project and additional training
    chunks.
  name: data_chunks
